Dynatrace Topology

The BigPanda Dynatrace Topology integration queries the Dynatrace API to retrieve your topology information, then processes and transforms the data into BigPanda enrichment maps. These maps are automatically uploaded to BigPanda to enrich incoming alerts with rich contextual 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.
• Use the v1 or v2 Dynatrace route to match your Dynatrace configuration.

❗️

Caution During Upgrade

To upgrade your Dynatrace Topology integration to leverage the v2 subscription route, you must DELETE the v1 subscription.

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.

   The token must have the read entities permission to access the topology data.

   For good security, do not enable any other toggles. BigPanda does not require any additional permissions.

5. Click Generate.

6. 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.

Ensure that Access problem and event feed, metrics, and topology permission toggle is enabled.

The token must have the read entities permission to access the topology data.

Configure the Dynatrace Integration in BigPanda

Retrieve your API Key in BigPanda > Integrations and send a one-time subscribe request, either using cURL or your favorite request client to the integration's configuration endpoint.

❗️

1 to 1 Environment ID

Each Dynatrace Environment ID can only have a single BigPanda subscription. If you have multiple BigPanda instances, such as a production and sandbox, they must have different Dynatrace Environment IDs.

📘

DynatraceManagedUrl

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",
    “Exclude”: [
	“really_long_tag_name”,
	“irrelevant_tag_name”
    ]
}'

curl --location --request POST 'https://integrations.bigpanda.io/dynatrace/topology/v2/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",
    “Exclude”: [
	“really_long_tag_name”,
	“irrelevant_tag_name”
    ]
}'

curl --location --request POST 'https://eu.integrations.bigpanda.io/dynatrace/topology/v2/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",
    “Exclude”: [
	“really_long_tag_name”,
	“irrelevant_tag_name”
    ]
}'

❗️

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 subscription is successful, BigPanda will process and create BigPanda enrichment schemas. This information will be retrieved from Dynatrace hourly using Dynatrace's Environment V1 or Dynatrace Monitored Entities V2 APIs.

Mapped enrichment tables for v1 and v2:

• application
• host
• service

Additional mapped enrichment tables for v2:

• custom_device
• process_group
• process_group_instance

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.

Default Mapped Columns

Each enrichment tag in the table, including additional columns for the Dynatrace tags, will be added to each BigPanda Alert where the dynatrace_<entity type> tags match.

Uninstall the Integration

Deleting an integration requires that you remove the integration in both the integrated system and BigPanda. We recommend that you first uninstall the integration on the integrated system to prevent traffic from being sent and rejected by BigPanda, since the app key will not exist once you delete the integration in BigPanda.

❗️

Caution During Replacement

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

Deactivate Inbound Integration

If you want to stop sending data to BigPanda but don’t want to delete your integration, you can temporarily deactivate it.

To deactivate an inbound integration:

1. In BigPanda, navigate to the Integrations tab and select the desired integration from the list. This will open integration details on the right side of the window.
2. At the top of the integration details, click the Active/Inactive toggle next to the application name to change the status of the integration.

In the integrations list, inactive integrations will be marked with a gray bar.

Stop Sending Data to BigPanda

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://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"
}'

curl --location --request DELETE 'https://integrations.bigpanda.io/dynatrace/topology/v2/subscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DynatraceEnvironmentId": "DYNATRACE_ENVIRONMENT_ID",
    "DynatraceApiKey": "DYNATRACE_API_KEY_CREATED_EARLIER",
    "BigPandaApiKey": "BIGPANDA_API_KEY"
}'

curl --location --request DELETE 'https://eu.integrations.bigpanda.io/dynatrace/topology/v2/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.

❗️

Data Removal

This procedure does not remove any data from the integrated system.