Datadog
Use the Datadog integration to ingest alerts raised by the monitoring system and respond to them automatically.
Datadog gives you the ability to create monitors that actively check metrics, integration availability, network endpoints, and more.
The Spot Connect Datadog integration provides you with the list of available monitors and selects the monitor to trigger a workflow when it goes into the state of Alert.
Datadog in a Spot Connect workflow enables you to:
- Trigger a workflow in Spot Connect, when a specific Datadog monitor goes into the state of Alert.
- Retrieve data from Datadog Monitors based on a search query.
- Return the test result from all the synthetic tests.
- Retrieve usage metrics by product family.
Configure Datadog in Spot Connect
- In the left main menu, click Connect and click Settings.
- Under the Integrations tab, select Datadog.
- Configure a new integration instance with the information below.
Details needed to set up a Datadog instance in Spot Connect:
| Parameter | Description | Required |
|---|---|---|
| Integration Alias | A name for the integration instance | Required |
| Datadog API Key | API key for your Datadog instance | Required |
| Datadog Application Key | Application key for your Datadog instance | Required |
-
Log in to your Datadog account.
-
In your Datadog account, click Organization Settings.
-
Click your username in the bottom left corner.
-
Select Organization Settings.
-
Select Access and then API Keys.
-
Click +New Key.
-
Provide a new name for the API Key and click Create Key.
-
Copy the API Key value and paste it into the Datadog API Key field in Spot Connect.
-
Select Access and then Application Keys.
-
Click +New Key.
-
Enter a new name for Application Key field and click Create Key.
-
Copy the Application Key value and paste into the Datadog Application Key field in Spot Connect.
Integration Actions
You can add these actions in the Spot Connect workflow builder as part of your workflow.
Datadog Alert Trigger
To execute a Spot Connect workflow with a Datadog alert, complete the following steps to set up a webhook integration between Spot Connect and Datadog.
In Spot Connect
If you do not already have a Spot Connect API Key, first create one by completing the following steps:
-
In the left main menu, click Connect and click Settings.
-
Click Resources and then click API Keys.
-
Click the Workflows page to create a new workflow with a proper trigger type.
-
On the Workflows page, select New Workflow and enter a name for the workflow.
-
Click Datadog and open the workflow builder.
-
In the workflow builder, click the Datadog trigger node to open the right panel.
-
Under the Webhook API Key Name, select an API Key you created earlier.
-
Compose your workflow and save it.
In Datadog
-
Click Integrations and then click the Integration tab.
-
In the search bar, search and select Webhooks.
-
Click + New to create a new Webhook.
-
Complete the New Webhook interface with the following information:
-
Enter a Datadog Webhook Name.
-
Copy the Workflow Webhook URL from the Spot Connect Workflow as the URL of the New Webhook.
-
Add "alert_id": "$ALERT_ID" in the JSON object for Payload. Optionally, add or remove any other fields.
-
Mark the Custom Headers box.
-
Copy the JSON header information below and paste it into the Custom Header field:
{
"x-api-key": "<Spot-Connect-api-key>",
"Content-Type": "application/json"
}
-
-
Replace < Spot-Connect-api-key >.
-
Choose one of the Webhook API Key Names from the dropdown menu in the Spot Connect Workflow panel, and the corresponding Webhook API Key Value will appear.
Note: If no options are available for the Webhook API Key Name, click Settings. Under the Integrations tab, click API Keys to create a New API Key.
-
Copy the Webhook API Key Value and replace
< Spot-Connect-api-key >in the header. -
Click Save to complete Webhook creation.
This is an example monitor created in Datadog that sends notifications to the selected Webhook:
You can see that the webhook triggered the Spot Connect workflow.
Datadog Get API Test Results
Use the action to get the last 50 test results summaries for all Synthetic API tests.
Input
| Parameter | Description | Required |
|---|---|---|
| Datadog Instance | Select a Datadog integration instance configured in Spot Connect | Required |
| Start Timestamp | Date-time from which to start querying results | Optional |
| End Timestamp | Date-time up to which to query results | Optional |
Output
| Parameter | Type | Description |
|---|---|---|
| result | Object | A list of test result objects in JSON |
| execution_status | String | Status of run (for example, S-OK, E_FAIL) |
Action Example
-
From the workflow builder in the left panel, drag and drop the Datadog Get API Test Results action node onto the workflow builder.
-
Click the action node and select a Datadog integration instance.
-
Save and execute the workflow.
Datadog Search Monitors
Perform a search query and return matching monitors.
Input
| Parameter Name | Description | Required |
|---|---|---|
| Datadog Instance | Select a Datadog integration instance configured in Spot Connect | Required |
| Query | The query to be executed. Query documentation: <https://docs.datadoghq.com/monitors/manage_monitor/#find-the-monitors> | Required |
| Page Index | Page to start paginating from | Optional |
| Monitors Per Page | Number of monitors to return per page | Optional |
| Sort Order | String for sort order, composed of field and sort order separate by a comma, e.g. name,asc. Supported sort directions: asc, desc. Supported fields: name, status, tags | Optional |
Output
| Parameter Name | Type | Description |
|---|---|---|
| result | Object | A list of Monitors in JSON |
| execution_status | String | Status of run (for example, S-OK, E_FAIL) |
Action Example
-
From the workflow builder in the left panel, drag and drop the Datadog Search Monitors action node onto the workflow builder.
-
Click the action node.
-
Select a Datadog integration instance.
-
Enter a Datadog monitor search query. View the syntax.
-
Enter Optional inputs such as Page Index, Monitors Per Page, Sort Index for further filtering.
-
Save and execute the workflow.