Datadog Connector
The Datadog connector enables the indexing of Datadog dashboards and notebooks.
Indexed dashboards and notebooks respect Datadog’s granular access controls: if a dashboard or notebook is restricted, it is only searchable in Atolio by the users, teams, roles or organizations that are granted viewer or editor access to it in Datadog. Unrestricted dashboards and notebooks are searchable by all Datadog users in your account.
What Is Indexed
| Resource | Indexed content |
|---|---|
| Dashboards | Title and description. |
| Notebooks | Title and the text of Markdown cells. Graph, query and other non-text cells are not indexed. |
Create API and Application Keys
The connector authenticates with a Datadog API key and application key.
- In Datadog, navigate to Organization Settings → API Keys and create a new API key, e.g.
Atolio. Copy the key value. - Navigate to Organization Settings → Application Keys and create a new application key, e.g.
Atolio. Copy the key value; it is only shown once.
An application key acts with the permissions of the user who created it. Ideally, create it as a service user who can read users, teams, roles, dashboards, notebooks and their restriction policies, such as a user with the Datadog Admin role.
If you scope the application key, it must still allow read access to all of the above. Leaving the application key unscoped is the simplest option.
Identify Your Datadog Site
Datadog accounts are hosted on one of several Datadog sites. You can identify yours from the URL you use to log in to Datadog:
| Login URL | Site |
|---|---|
https://app.datadoghq.com | datadoghq.com (default) |
https://us3.datadoghq.com | us3.datadoghq.com |
https://us5.datadoghq.com | us5.datadoghq.com |
https://app.datadoghq.eu | datadoghq.eu |
https://ap1.datadoghq.com | ap1.datadoghq.com |
https://app.ddog-gov.com | ddog-gov.com |
If your account is on the default datadoghq.com site, no site needs to be configured.
Provide Configuration
Provide the following values to your Deployment Engineer for them to configure in Atolio:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
api_key | secret | Yes | — | The Datadog API key you created. |
application_key | secret | Yes | — | The Datadog application key you created. |
site-override | string | No | datadoghq.com | Your Datadog site, e.g. datadoghq.eu. Leave empty for the default site. |
When the configuration is saved, Atolio validates the API and application keys against the Datadog API.
Limitations
- A dashboard or notebook is skipped if its creator’s Datadog user cannot be found (for example, the creator has been removed from the account), or if its restriction policy cannot be read.
- Monitors, logs, metrics, SLOs and other Datadog resources are not currently indexed.