Dynatrace Topology

This integration allows you to enrich alerts coming into BigPanda with topology information from Dynatrace.

Supported Versions

Type

Authentication Type

SaaS

API

Bearer Token

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.

How it Works

The BigPanda Dynatrace Topology integration works by querying the Dynatrace API to retrieve your topology information every hour. The data is then processed and transformed into a BigPanda enrichment which is automatically uploaded to BigPanda to enrich your incoming alerts.

Installing 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 setup

Configure the Dynatrace Integration in BigPanda

  1. Create an API Key in BigPanda
  2. Send a one-time subscribe request, either using cURL or your favorite request client, to the integration's configuration endpoint.
curl --location --request POST '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_CREATED_EARLIER"
}'

🚧

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 applications 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 Tag

Description

application

The name of the Dynatrace application as displayed in the UI

management_zones

The management zones that the application is part of, separated by a pipe (|)

e.g. zone 1|zone 2

tags

A list of the custom tags associated with the application, separated by a pipe (|)

e.g. tag 1|tag 2

Dynatrace Tags

Each 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 Tag

Description

host

The name of the Dynatrace host as displayed in the UI

host_group

The name of the Dynatrace host group, as displayed in the UI

management_zones

The management zones that the host is part of, separated by a pipe (|)

e.g. zone 1|zone 2

software

A list of the software technologies used by the host, including type, edition, and version number as applicable. Separated by a pipe (|)

e.g. KUBERNETES worker v1.11.0+d4cacc0|OPENSHIFT 3.11.161

tags

A list of the custom tags associated with the host, separated by a pipe (|)

e.g. tag 1|tag 2

Dynatrace Tags

Each 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 Tag

Description

service

The name of the Dynatrace service as displayed in the UI

management_zones

The management zones that the service is part of, separated by a pipe (|)

e.g. zone 1|zone 2

software

A list of the software technologies used by the service, including type, edition, and version number as applicable. Separated by a pipe (|)

e.g. KUBERNETES worker v1.11.0+d4cacc0|OPENSHIFT 3.11.161

tags

A list of the custom tags associated with the service, separated by a pipe (|)

e.g. tag 1|tag 2

Dynatrace Tags

Each Dynatrace contextual tag associated with the service will appear in their own column

Uninstalling the Integration

Unsubscribe from Integration

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

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