diff --git a/plugins/dynatrace/README.md b/plugins/dynatrace/README.md index e5684b2017..8ea66e4c15 100644 --- a/plugins/dynatrace/README.md +++ b/plugins/dynatrace/README.md @@ -2,13 +2,17 @@ Welcome to 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 = ( + + [...] + + + + +) + +``` + #### Plugin Configuration This plugin requires a proxy endpoint for Dynatrace configured in `app-config.yaml` like so: diff --git a/plugins/dynatrace/assets/plugin.png b/plugins/dynatrace/assets/plugin.png new file mode 100644 index 0000000000..b1b9b0c7a7 Binary files /dev/null and b/plugins/dynatrace/assets/plugin.png differ