Merge pull request #15052 from padupe/docs/plugin-dynatrace-update

docs(plugins/dynatrace): update doc with install processing.
This commit is contained in:
Fredrik Adelöw
2022-12-07 11:24:50 +01:00
committed by GitHub
3 changed files with 43 additions and 1 deletions
+38 -1
View File
@@ -2,13 +2,17 @@
Welcome to the Dynatrace plugin!
![Example of the Dynatrace plugin](./assets/plugin.png)
## Getting started
This plugin uses the Backstage proxy to communicate with Dynatrace's REST APIs.
### Setup
#### Dynatrace API Key
#### Requirements
##### Dynatrace API Key
The Dynatrace plugin will require the following information, to be used in the configuration options detailed below:
@@ -17,6 +21,39 @@ The Dynatrace plugin will require the following information, to be used in the c
- `entities.read`
- `problems.read`
#### Install
1. Install the plugin on your frontend:
```
yarn add --cwd packages/app @backstage/plugin-dynatrace
```
2. We created in our catalog the interface for using the integration with Dynatrace.
```diff
# packages/app/src/components/catalog/EntityPage.tsx
[...]
+ import { DynatraceTab, isDynatraceAvailable } from '@backstage/plugin-dynatrace'
[...]
const serviceEntityPage = (
<EntityLayout>
[...]
+ <EntityLayout.Route
+ path="/dynatrace"
+ title="Dynatrace"
+ if={isDynatraceAvailable}
+ >
+ <DynatraceTab />
+ </EntityLayout.Route>
</EntityLaytou>
)
```
#### Plugin Configuration
This plugin requires a proxy endpoint for Dynatrace configured in `app-config.yaml` like so:
Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

+5
View File
@@ -12,6 +12,11 @@
"backstage": {
"role": "frontend-plugin"
},
"repository": {
"type": "git",
"url": "https://github.com/backstage/backstage",
"directory": "plugins/dynatrace"
},
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",