Datadog Topology
Supported Versions | Type | Authentication Type |
|---|---|---|
SaaS | API | User API Key |
The BigPanda Datadog Topology integration works by first querying the Datadog 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 Datadog.
Key Features
Enriches alerts in BigPanda with topology information from Datadog.
Automatically detects enrichment schema from your Datadog topology data.
Automatically creates and manages Enrichments in BigPanda.
Datadog Topology imports
Datadog Topology imports run on a 6 hour schedule. Data is retrieved using the following API endpoint: https://api.datadoghq.com/api/v1/service_dependencies
Install the Integration
Install the Integration by following these steps:
Create a Datadog API Token and Datadog Application Key for BigPanda
In Datadog, navigate to the bottom left corner of the screen and click your user icon.
Navigate to Organization Settings > API Keys.
Under API Keys give the token a name such as "BigPanda Topology Integration" then click Create API Key.
Under Application Keys give the token a name such as "BigPanda Topology Integration" then click Create APP Key.
View the newly created API Token and App Key. Copy the generated tokens, saving them for use later in the setup.
Configure the Datadog Integration in BigPanda
Send a one-time install request, either using cURL or your favorite request client to the integration's configuration endpoint.
Make sure that you provide the following parameters in the body:
Parameter Name | Values | Description |
|---|---|---|
| "install" | This tells BigPanda to start polling with the information provided in the payload |
| Token | The Datadog API Key |
| Token | The Datadog Application Key |
| Token | The BigPanda API Key |
| Empty list or List of Strings | This contains the list of environments in Datadog from which to poll for topology information. If the list is empty it will not poll any topology data |
Case sensitive
Make sure the values for serviceMapEnvironments are lower case.
This is the install request:
curl --location --request POST 'https://integrations.bigpanda.io/datadog/configure' \
--header 'Content-Type: application/json' \
--data-raw '{
"action": "install",
"dataDogApiKey": "XXXXXXX",
"dataDogAppKey": "XXXXXXX",
"bigPandaApiToken": "XXXXXXX",
"serviceMapEnvironments": ["env1", "env2",...]
}'
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
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.
Replacing an existing integration
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
On the integrated system, disable any settings that send data to BigPanda.
Manually resolve any open alerts sent from the integration to remove the associated incidents from your incident feed. These incidents will not automatically resolve without an ok status from the original sending integration.
Send a one-time unsubscribe request, either using cURL or your favorite request client to the integration's configuration endpoint.
Parameter Name | Values | Description |
|---|---|---|
| "uninstall" | This tells BigPanda that we would like to remove the configuration for the provided Datadog API Key and stop polling for topology data |
| Token | This is the Datadog API Key |
| Token | The Datadog Application Key |
This is the uninstall request:
```Uninstall cURL request
curl --location --request POST 'https://inbound.bigpanda.io/datadog/configure' \
--header 'Content-Type: application/json' \
--data-raw '{
"action": "uninstall",
"dataDogApiKey": "XXXXXXX",
"dataDogAppKey": "XXXXXXX"
}'
```Clean Up API Tokens
In Datadog, navigate to Integrations > APIs.
Locate the API token for the BigPanda Topology Integration.
Click the Revoke button to delete the token.
Locate the Application Key token for the BigPanda Topology Integration.
Click the Revoke button to delete the token.
Delete the Integration from BigPanda
In BigPanda, navigate to the Integrations tab and select the desired integration from the list.
In the integration details on the right, click Delete Integration. A support message opens, pre-populated with a request to delete the selected integration.
Press Enter to send the request.
The BigPanda support team will remove the integration from the UI.
Data removal
This procedure does not remove any data from BigPanda or the integrated system. As needed, remove data from each system before deleting the integration.