Datadog
Datadog is a cloud-scale application observability solution that monitors servers, databases, tools, and services. Nobl9 connects with Datadog to collect SLI measurements and compare them to SLO targets. Nobl9 can activate processes and notifications when the error budget burn rate is too high or has been surpassed because it calculates error budgets of acceptable thresholds.
Users can pass business context through monitoring data, developing and measuring reliability targets, and aligning activities against the error budget's priorities using Nobl9 integration with Datadog.
Datadog parameters and supported features in Nobl9
- General support:
- Release channel: Stable, Beta
- Connection method: Agent, Direct
- Replay and SLI Analyzer: Historical data limit 30 days
- Event logs: Supported
- Query checker: Supported
- Query parameters retrieval: Supported
- Timestamp cache persistence: Supported
- Query parameters:
- Query interval: 2 min
- Query delay: 1 min
- Jitter: 15 sec
- Timeout: 30 sec
- Agent details and minimum required versions for supported features:
- Plugin name: n9datadog
- Query delay environment variable: DATADOG_QUERY_DELAY
- Replay and SLI Analyzer: 0.65.0
- Query parameters retrieval: 0.73.2
- Timestamp cache persistence: 0.65.0
Authentication
To deploy the Nobl9 agent, provide an API Key and Application Key with the DD_API_KEY and DD_APPLICATION_KEY environment variables.
Alternatively,
you can pass credentials using a local configuration file with the api_key and application_key keys under the n9datadog
section.
Learn how to obtain API and Application Keys.
To connect to Datadog,
the Nobl9 agent scrapes the /api/v1/query endpoint that requires the timeseries_query authorization scope.
Make sure your application has access to this scope before you connect to Datadog.
Learn more about Query timeseries data across multiple products.
Adding Datadog as a data source
To ensure data transmission between Nobl9 and Datadog, it may be necessary to list Nobl9 IP addresses as trusted.
IP addresses to include in your allowlist for secure access
app.nobl9.com instance:- 18.159.114.21
- 18.158.132.186
- 3.64.154.26
us1.nobl9.com instance:- 34.121.54.120
- 34.123.193.191
- 34.134.71.10
- 35.192.105.150
- 35.225.248.37
- 35.226.78.175
- 104.198.44.161
You can add Datadog as the data source using the direct or agent connection methods.
Direct connection method
Direct connection to Datadog requires entering your Datadog credentials.
Nobl9 Web
- Navigate to Integrations > Sources.
- Click
.
- Click your required Source tile.
- Choose Direct.
-
Select one of the following Release Channels:
- The
stablechannel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abetarelease. Use it to avoid crashes and other limitations. - The
betachannel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Enter the Datadog Site for connection.
It is a Datadog SaaS instance that corresponds to one of Datadog's available locations:datadoghq.com(formerly referred to ascom),us3.datadoghq.comus5.datadoghq.comdatadoghq.eu(formerly referred to aseu),ddog-gov.com,ap1.datadoghq.com
-
Enter your Datadog API Key and Application Key.
- Select a Project (mandatory).
Projects provide the structure for organizing Nobl9 resources and managing access permissions.
If a project is not specified, Nobl9 assigns the default project value automatically. - Enter a Display Name (optional).
Spaces are allowed. - Enter a Name (mandatory).
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description (optional).
Provide extra details, such as the purpose and responsible personnel.
Up to 1050 characters. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Datadog integration for Query delay is
1 minute.
Changing the query delayChanging the query delay can affect your SLI data.
Learn more about query delay and its impact. - The default value in Datadog integration for Query delay is
- Configure how Nobl9 uses your data source’s historical data for Replay and SLI Analyzer.
These features allow you to backfill SLOs or analyze SLIs for assisted SLO creation. - Maximum period for historical data retrieval (optional).
- Defines the furthest point in the past from which data can be retrieved.
- To activate Replay and SLI Analyzer for your data source, set this value to a positive whole number.
- The maximum period is capped by your data source's specific limitations. Find the maximum value for your data source.
- Default period for historical data retrieval (optional).
- Sets the automatic backfill window for new SLOs using this data source.
- Enter 0 or a positive whole number (default: 0). You can change this value for individual SLOs during creation.
- Setting a non-zero value results in automatic replay of newly created SLOs based on this data source, so they report past performance upon creation, rather than waiting for new data to accumulate.
- Click Add Data Source
YAML
- Create a YAML definition to set up a direct connection with Datadog. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Direct
metadata:
name: datadog
displayName: Datadog Direct
project: default
annotations:
area: latency
env: prod
region: us
team: sales
spec:
description: Example Datadog Direct
releaseChannel: stable
datadog:
site: com
apiKey: "[secret]"
applicationKey: "[secret]"
historicalDataRetrieval:
maxDuration:
value: 30
unit: Day
defaultDuration:
value: 15
unit: Day
queryDelay:
value: 2
unit: Minute
| Field | Type | Description |
|---|---|---|
queryDelay.unitMandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute. • Check query delay documentation for default unit of query delay for each source. |
queryDelay.value Mandatory | numeric | Specifies the value for the query delay. • Must be a number less than 1440 minutes (24 hours). • Check query delay documentation for default unit of query delay for each source. |
logCollectionEnabledOptional | boolean | Optional. Defaults to false. Set to true if you'd like your direct to collect event logs. Contact us to activate it. |
releaseChannelMandatory | enum | Specifies the release channel. Accepted values: beta | stable. |
| Source-specific fields | ||
datadog.siteMandatory | string | Datadog SaaS instance that corresponds to one of Datadog's available locations: • datadoghq.com (formerly referred to as `COM`)• us3.datadoghq.com • us5.datadoghq.com• datadoghq.eu (formerly referred to as `EU`)• ddog-gov.com• ap1.datadoghq.com |
datadog.apiKeyMandatory | string, secret | See authentication section above for more details. |
datadog.applicationKeyMandatory | string, secret | See authentication section above for more details. |
| Replay-related fields | ||
historicalDataRetrievalOptional | n/a | Optional structure related to configuration related to Replay. ❗ Use only with supported sources. • If omitted, Nobl9 uses the default values of value: 0 and unit: Day for maxDuration and defaultDuration. |
maxDuration.valueOptional | numeric | Specifies the maximum duration for historical data retrieval. Must be integer ≥ 0. See Replay documentation for values of max duration per data source. |
maxDuration.unitOptional | enum | Specifies the unit for the maximum duration of historical data retrieval. Accepted values: Minute | Hour | Day. |
defaultDuration.valueOptional | numeric | Specifies the default duration for historical data retrieval. Must be integer ≥ 0 and ≤ maxDuration. |
defaultDuration.unitOptional | enum | Specifies the unit for the default duration of historical data retrieval. Accepted values: Minute | Hour | Day. |
- Apply your YAML definition using the
sloctl applycommand.
Agent connection method
For the agent connection method, credentials aren't required. With this method, you must deploy your Datadog agent to activate data collection.
Nobl9 Web
- Navigate to Integrations > Sources.
- Click
.
- Click your required Source tile.
- Choose Agent.
-
Select one of the following Release Channels:
- The
stablechannel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abetarelease. Use it to avoid crashes and other limitations. - The
betachannel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Enter the Datadog Site for connection.
It is a Datadog SaaS instance that corresponds to one of Datadog's available locations:datadoghq.com(formerly referred to ascom),us3.datadoghq.comus5.datadoghq.comdatadoghq.eu(formerly referred to aseu),ddog-gov.com,ap1.datadoghq.com
- Select a Project (mandatory).
Projects provide the structure for organizing Nobl9 resources and managing access permissions.
If a project is not specified, Nobl9 assigns the default project value automatically. - Enter a Display Name (optional).
Spaces are allowed. - Enter a Name (mandatory).
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description (optional).
Provide extra details, such as the purpose and responsible personnel.
Up to 1050 characters. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Datadog integration for Query delay is
1 minute.
Changing the query delayChanging the query delay can affect your SLI data.
Learn more about query delay and its impact. - The default value in Datadog integration for Query delay is
- Configure how Nobl9 uses your data source’s historical data for Replay and SLI Analyzer.
These features allow you to backfill SLOs or analyze SLIs for assisted SLO creation. - Maximum period for historical data retrieval (optional).
- Defines the furthest point in the past from which data can be retrieved.
- To activate Replay and SLI Analyzer for your data source, set this value to a positive whole number.
- The maximum period is capped by your data source's specific limitations. Find the maximum value for your data source.
- Default period for historical data retrieval (optional).
- Sets the automatic backfill window for new SLOs using this data source.
- Enter 0 or a positive whole number (default: 0). You can change this value for individual SLOs during creation.
- Setting a non-zero value results in automatic replay of newly created SLOs based on this data source, so they report past performance upon creation, rather than waiting for new data to accumulate.
- Click Add Data Source
- Deploy your agent in a Kubernetes cluster or Docker container.
YAML
- Create a YAML definition to set up an agent connection with Datadog. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Agent
metadata:
name: datadog
displayName: Datadog Agent
project: default
annotations:
area: latency
env: prod
region: us
team: sales
spec:
description: Example Datadog Agent
releaseChannel: stable
datadog:
site: com
historicalDataRetrieval:
maxDuration:
value: 30
unit: Day
defaultDuration:
value: 15
unit: Day
queryDelay:
value: 2
unit: Minute
| Field | Type | Description |
|---|---|---|
queryDelay.unitMandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute. • Check query delay documentation for default unit of query delay for each source. |
queryDelay.value Mandatory | numeric | Specifies the value for the query delay. • Must be a number less than 1440 minutes (24 hours). • Check query delay documentation for default unit of query delay for each source. |
releaseChannelMandatory | enum | Specifies the release channel. Accepted values: beta | stable. |
| Source-specific fields | ||
datadog.siteMandatory | string | Datadog SaaS instance that corresponds to one of Datadog's available locations: • datadoghq.com (formerly referred to as `com`)• us3.datadoghq.com • us5.datadoghq.com• datadoghq.eu (formerly referred to as `eu`)• ddog-gov.com• ap1.datadoghq.com |
| Replay-related fields | ||
historicalDataRetrievalOptional | n/a | Optional structure related to configuration related to Replay. ❗ Use only with supported sources. • If omitted, Nobl9 uses the default values of value: 0 and unit: Day for maxDuration and defaultDuration. |
maxDuration.valueOptional | numeric | Specifies the maximum duration for historical data retrieval. Must be integer ≥ 0. See Replay documentation for values of max duration per data source. |
maxDuration.unitOptional | enum | Specifies the unit for the maximum duration of historical data retrieval. Accepted values: Minute | Hour | Day. |
defaultDuration.valueOptional | numeric | Specifies the default duration for historical data retrieval. Must be integer ≥ 0 and ≤ maxDuration. |
defaultDuration.unitOptional | enum | Specifies the unit for the default duration of historical data retrieval. Accepted values: Minute | Hour | Day. |