From 7b7ea593d7201e39d264797e0ba04c58663a3478 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:46:06 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713465964371.md | 5 ++ plugins/dynatrace/README.md | 120 +--------------------------- plugins/dynatrace/package.json | 6 +- 3 files changed, 11 insertions(+), 120 deletions(-) create mode 100644 .changeset/migrate-1713465964371.md diff --git a/.changeset/migrate-1713465964371.md b/.changeset/migrate-1713465964371.md new file mode 100644 index 0000000000..1084c6d243 --- /dev/null +++ b/.changeset/migrate-1713465964371.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-dynatrace': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/dynatrace/README.md b/plugins/dynatrace/README.md index 73ac545265..3655334b05 100644 --- a/plugins/dynatrace/README.md +++ b/plugins/dynatrace/README.md @@ -1,119 +1,3 @@ -# Dynatrace +# Deprecated -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 - -#### Requirements - -##### Dynatrace API Key - -The Dynatrace plugin will require the following information, to be used in the configuration options detailed below: - -- Dynatrace API URL, e.g. `https://my-dynatrace-instance.dynatrace.com/api/v2` -- Dynatrace API access token (see [documentation](https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication)), with the following permissions: - - `entities.read` - - `problems.read` - - `DataExport` and/or `ExternalSyntheticIntegration` and/or `ReadSyntheticData` - -#### Install - -1. Install the plugin on your frontend: - -``` -# From your Backstage root directory -yarn --cwd packages/app add @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: - -```yaml -proxy: - endpoints: - '/dynatrace': - target: 'https://example.dynatrace.com/api/v2' - headers: - Authorization: 'Api-Token ${DYNATRACE_ACCESS_TOKEN}' -``` - -It also requires a `baseUrl` for rendering links to problems in the table like so: - -```yaml -dynatrace: - baseUrl: 'https://example.dynatrace.com' -``` - -#### Catalog Configuration - -##### View Recent Application Problems - -To show information from Dynatrace for a catalog entity, add the following annotation to `catalog-info.yaml`: - -```yaml -# catalog-info.yaml -# [...] -metadata: - annotations: - dynatrace.com/dynatrace-entity-id: DYNATRACE_ENTITY_ID -# [...] -``` - -The `DYNATRACE_ENTITY_ID` can be found in Dynatrace by browsing to the entity (a service, synthetic, frontend, workload, etc.). It will be located in the browser address bar in the `id` parameter and has the format `ENTITY_TYPE-ENTITY_ID`, where `ENTITY_TYPE` will be one of `SERVICE`, `SYNTHETIC_TEST`, or other, and `ENTITY_ID` will be a string of characters containing uppercase letters and numbers. - -##### Viewing Recent Synthetics Results - -To show recent results from a Synthetic Monitor, add the following annotation to `catalog-info.yaml`: - -```yaml -# catalog-info.yaml -# [...] -metadata: - annotations: - dynatrace.com/synthetics-ids: SYNTHETIC_ID, SYNTHETIC_ID_2, ... -# [...] -``` - -The annotation can also contain a comma or space separated list of Synthetic Ids to surface details for multiple monitors! - -The `SYNTHETIC_ID` can be found in Dynatrace by browsing to the Synthetic monitor. It will be located in the browser address bar in the resource path - `https://example.dynatrace.com/ui/http-monitor/HTTP_CHECK-1234` for an Http check, or `https://example.dynatrace.com/ui/browser-monitor/SYNTHETIC_TEST-1234` for a browser clickpath. - -## Contribution - -This plugin was originally built by [TELUS](https://github.com/telus). - -## Disclaimer - -This plugin is not officially supported by Dynatrace. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-dynatrace` instead. diff --git a/plugins/dynatrace/package.json b/plugins/dynatrace/package.json index babe6a2c76..8225ae0139 100644 --- a/plugins/dynatrace/package.json +++ b/plugins/dynatrace/package.json @@ -2,7 +2,8 @@ "name": "@backstage/plugin-dynatrace", "version": "10.0.3", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-dynatrace" }, "publishConfig": { "access": "public", @@ -55,5 +56,6 @@ "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-router-dom": "6.0.0-beta.0 || ^6.3.0" }, - "configSchema": "config.d.ts" + "configSchema": "config.d.ts", + "deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-dynatrace instead." }