Introduction
Datadog is a monitoring service for cloud-scale applications, providing monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform.
This guide explains how to obtain authentication details from Datadog, as well as how to install a Datadog Connector.
Setup & Authentication
Remote Setup in Datadog – performed by your customer
Your customer should go to their Datadog account to obtain their Site URL and generate an API Key.
If you will be using any of the Datadog Connector’s Methods that require an Application Key (details below), they should also generate an Application Key scoped to those Methods.
| Property | Description |
|---|---|
| Site URL | Found within Datadog at the top of the Personal Settings > My Preferences page. See Datadog’s guide on obtaining the Site URL. |
| API Key | Your customer can generate an API Key within Datadog on the Organization Settings > API Keys page. See Datadog’s guide on generating an API key. |
| Application Key (optional) | If you’ll be using Connector Methods that require an Application Key (see below), your customer can generate one within Datadog on the Personal Settings > Application Keys page. See Datadog’s guide on generating an application key. |
Connector Methods Requiring a Datadog Application Key
If your integrations within Cyclr will use any of the Connector Methods listed in the table below, your customer will need to create an Application Key within Datadog with the Scopes shown alongside them.
If a Connector Method is not listed in this table, it does not require a Datadog Application Key to use it.
| Connector Methods | Scopes |
|---|---|
| Dashboards (all Methods) | dashboards_read |
| Logs * Search Logs | logs_read_data |
| Metrics * Get Metric * List Metrics | metrics_read |
| Organizations * List Managed Organizations * List New Managed Organizations * List Updated Managed Organizations | org_management OR org_connections_write |
| Roles (all Methods) | user_access_read |
| Usage Metering (all Methods) | usage_read AND billing_read |
| Users (all Methods) | user_access_read |
Cyclr Connector Installation
When installing a Datadog Connector, the following values are used:
| Property | Description |
|---|---|
| API Key | The API Key associated with the Datadog organization. |
| Site URL | The URL of the Datadog site. |
| Application Key (optional) | The Application Key associated with the Datadog account. Only needed if using Connector Methods listed in the table above. |