Dynatrace Topology

Send topology data from Dynatrace to enrich BigPanda incidents.

Supported VersionsTypeAuthentication Type
SaaSAPIUser API Key

The BigPanda Dynatrace Topology integration works by first querying the Dynatrace API to retrieve your topology information. The data is then processed and transformed into a BigPanda enrichment which is automatically uploaded to BigPanda and immediately starts enriching your incoming alerts with topology information from Dynatrace.

Key Features

  • Enriches alerts in BigPanda with topology information from Dynatrace.
  • Automatically detects enrichment schema from your Dynatrace topology data.
  • Automatically creates and manages Enrichments in BigPanda.
  • Customer-managed Dynatrace endpoints (On-Premise) with externally accessible endpoints are supported by the standard integration.

Install the Integration

Create a Dynatrace API Token for BigPanda

  1. In Dynatrace, navigate to Settings > Integration > Dynatrace API.
  2. Under My Dynatrace API Tokens click Generate Token.
  3. Give the token a name such as "BigPanda Topology Integration.
  4. Ensure that Access problem and event feed, metrics, and topology permission toggle is enabled.
  • For good security, do not enable any other toggles. BigPanda does not require any additional permissions.
  1. Click Generate.
  2. View the newly created API Token and Copy the generated token, saving it for use later in the setup.

🚧

Error Handling

If a subscription message shows an error like Invalid Dynatrace Environment ID / API Key or insufficient permissons for API key, it's likely that the permissions were not set properly. See step 4.

Configure the Dynatrace Integration in BigPanda

  1. Retrieve your API Key in BigPanda > Integrations.
  2. Send a one-time subscribe request, either using cURL or your favorite request client to the integration's configuration endpoint. The DynatraceManagedUrl property is only necessary when subscribing an On-Premise / Customer Managed instance. When setting up a Cloud-Managed installation, do not use this property.
curl --location --request POST 'https://integrations.bigpanda.io/dynatrace/topology/subscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DynatraceEnvironmentId": "DYNATRACE_ENVIRONMENT_ID",
    "DynatraceApiKey": "DYNATRACE_API_KEY_CREATED_EARLIER",
    "BigPandaApiKey": "BIGPANDA_API_KEY",
    "DynatraceManagedUrl": "YOUR_DOMAIN_HERE"
}'

🚧

Integrations in the EU

If your BigPanda instance is based in the EU, you will need to add the eu. prefix in your request URL. See the Additional EU Guidelines for more details

🚧

Subscription Delay

Topology results will first appear in BigPanda 1 hour after the subscription request has been received

Enrichment Data

Once the export is successful, BigPanda will process and create three BigPanda enrichment schemas :
All Applications, all hosts, and all Services in a given environment. This information will be retrieved from Dynatrace hourly using Dynatrace's Environment V1 API.

Dynatrace Tags

The enrichment schemas created through Dynatrace are built primarily through tags. Dynatrace tags come in two types: Contextual and Custom. Depending on the tag type, this information will be used to enrich your data in different ways.

  • Contextual tags are associated with the application's origin (AWS, Azure, Google Cloud, etc). These tags are presented by Dynatrace as a key/value combo, and will be added to the enrichment map as a distinct property. e.g. If an AWS app has an appid of 1234, an appid column will be added to the enrichment map and the application row will have appid: 1234 associated with the BigPanda Alert.
  • Custom tags are added after deployment within Dynatrace. These will be added to the enrichment map under a tags column, separated by a pipe. e.g. tag 1|tag 2

📘

The Dynatrace tags included in each table will vary depending on application's origin and the enrichment information available. These contextual tags will be included in each table on its own column.

Application Enrichment Map

Each enrichment tag in the table, including additional columns for the Dynatrace tags, will be added to each BigPanda Alert where the application tags match.

Enrichment TagDescriptionExample
applicationThe name of the Dynatrace application as displayed in the UI
management_zonesThe management zones that the application is part of, separated by a pipe (|)zone 1|zone 2
tagsA list of the custom tags associated with the application, separated by a pipe (|)tag 1|tag 2
Dynatrace TagsEach Dynatrace contextual tag associated with the service will appear in their own column

Host Enrichment Map

Each enrichment tag in the table, including additional columns for the Dynatrace tags, will be added to each BigPanda Alert where the host tags match.

Enrichment TagDescriptionExample
hostThe name of the Dynatrace host as displayed in the UI
host_groupThe name of the Dynatrace host group, as displayed in the UI
management_zonesThe management zones that the host is part of, separated by a pipe (|)zone 1|zone 2
softwareA list of the software technologies used by the host, including type, edition, and version number as applicable. Separated by a pipe (|)KUBERNETES worker v1.11.0+d4cacc0|OPENSHIFT 3.11.161
tagsA list of the custom tags associated with the host, separated by a pipe (|)tag 1|tag 2
Dynatrace TagsEach Dynatrace contextual tag associated with the host will appear in their own column

Services Enrichment Map

Each enrichment tag in the table, including additional columns for the Dynatrace tags, will be added to each BigPanda Alert where the service tags match.

Enrichment TagDescriptionExample
serviceThe name of the Dynatrace service as displayed in the UI
management_zonesThe management zones that the service is part of, separated by a pipe (|)zone 1|zone 2
softwareA list of the software technologies used by the service, including type, edition, and version number as applicable. Separated by a pipe (|)KUBERNETES worker v1.11.0+d4cacc0|OPENSHIFT 3.11.161
tagsA list of the custom tags associated with the service, separated by a pipe (|)tag 1|tag 2
Dynatrace TagsEach Dynatrace contextual tag associated with the service will appear in their own column

Uninstall the Integration

Deleting an integration requires changes to both the integrated system and BigPanda. You must uninstall the integration on the integrated system and then delete the integration from BigPanda.

🚧

When replacing an existing integration with a new tool or system, we recommend configuring the new integration first to ensure no data is lost.

Stop Sending Data to BigPanda

  1. Send a one-time unsubscribe request, either using cURL or your favorite request client to the integration's configuration endpoint.
curl --location --request DELETE 'https://inbound.bigpanda.io/dynatrace/topology/subscribe' 
--header 'Content-Type: application/json' 
--data-raw '{
    "DynatraceEnvironmentId": "DYNATRACE_ENVIRONMENT_ID",
    "DynatraceApiKey": "DYNATRACE_API_KEY_CREATED_EARLIER",
    "BigPandaApiKey": "BIGPANDA_API_KEY" 
}'

Cleanup API Tokens

  1. In Dynatrace, navigate to Settings > Integration > Dynatrace API.
  2. Locate the API token for the BigPanda Topology Integration.
  3. Click the X button to delete the token.
  4. In BigPanda, delete the API Key used for the Dynatrace Topology Integration.

Delete the Integration from BigPanda

  1. In BigPanda, navigate to the Integrations tab and select the desired integration from the list.
  2. In the integration details on the right, click Delete Integration. A support message opens, pre-populated with a request to delete the selected integration.
  3. Press Enter to send the request.
  4. The BigPanda support team will remove the integration from the UI.

This procedure does not remove any data from BigPanda or the integrated system. As needed, remove data from each system before deleting the integration.