datadog-probe
Datadog APM probe allows you to query Datadog metrics or run Synthetic tests and compare the results against specified criteria. It supports a legacy single-query metrics path and a Datadog v2 timeseries path for structured, multi-query validation.
When to use
- Monitor Datadog metrics (e.g.,
system.cpu.user,trace.servlet.request.duration) as steady-state indicators during chaos - Query Datadog APM metrics (e.g., P95 latency, error rate) for a specific service using the v2 timeseries API
- Use Datadog Synthetic tests to validate end-to-end user flows under failure conditions
- Validate that Datadog-monitored SLOs remain within acceptable thresholds during fault injection
- Reuse a probe template across services by supplying service and environment values at runtime through probe variables
Prerequisites
- An active Datadog account
- Access to the Datadog API from the Kubernetes execution plane
- A Datadog API key and Application key for authentication. See Datadog API Keys and Application Keys
Steps to configure
-
Navigate to Project Settings > Chaos Probes and click + New Probe
-
Select APM Probe, provide a name, and select Datadog under APM Type
-
Under Variables, define any reusable values you want to reference in probe properties or run properties. For each variable, specify the type (
StringorNumber), name, value (fixed or runtime input), and whether it's required at runtime. Use expressions such as<+probe.variables.SERVICE_NAME>in query parameters to make a probe reusable across services. -
Under Datadog Connector, select an existing connector or click + New Connector to create one. Provide the Datadog instance URL, Application key, and API key, configure the delegate, verify the connection, and click Finish.
-
Under Probe Properties, select the query mode and configure:
Legacy metrics mode (v1):
Field Description Datadog Query Single Datadog metrics query string.
Example:avg:system.cpu.user{host:my-host}. See Datadog Metrics documentationLookback Window (in minutes) Time range from the specified number of minutes ago to now v2 timeseries mode:
Use this mode when you need structured queries, APM metrics, or formulas across multiple named queries. Set
queryTypetov2and define one or more named queries.Field Description Query Type Set to v2to use the Datadog Timeseries Formula Query APIQueries List of named queries evaluated by Datadog. Each query has a name,dataSource, andparamsFormula Expression evaluated against the named queries (for example, p95*1000orerrors / hits). If only one query is defined, the formula defaults to that query's nameAggregation How datapoints in the lookback window are collapsed before comparison. Supported values: mean(default),max,min,lastLookback Window (in minutes) Time range from the specified number of minutes ago to now ( durationInMin)Supported query data sources:
Data source Description Required params metricsDatadog metrics query query— Datadog metrics query string (for example,sum:trace.servlet.request.hits{service:account-service}.as_count())apm_metricsDatadog APM metrics stat— APM statistic (for example,latency_p95,error_rate).serviceis typically required.env,span_kind,group_by, andquery_filterare optionalSynthetic Test mode:
Field Description Synthetic Test Provide the Synthetic test details (API test or Browser test) to evaluate the probe outcome. See Datadog Synthetics documentation Under Datadog Data Comparison, provide:
Field Description Type Data type for comparison: FloatorIntComparison Criteria Comparison operator: >=,<=,==,!=,>,<,oneOf,betweenValue The expected value to compare against the metric result -
Provide the Run Properties:
Field Description Timeout Maximum time for probe execution (e.g., 10s)Interval Time between successive executions (e.g., 2s)Attempt Number of retry attempts (e.g., 1)Polling Interval Time between retries (e.g., 30s)Initial Delay Delay before first execution (e.g., 5s)Verbosity Log detail level Stop On Failure (optional) Stop the experiment if the probe fails -
Click Create Probe
Datadog v2 APM metrics example
The following probe template checks the P95 latency of a service using Datadog APM metrics. The service name is supplied at runtime; the environment is optional.
identity: datadog-p95-latency-check
name: Datadog P95 Latency Check
type: apmProbe
infrastructureType: Kubernetes
probeProperties:
apmProbe:
comparator:
type: float
value: <+input>
criteria: <=
type: Datadog
datadogApmProbeInputs:
connectorID: <+input>
durationInMin: <+input>
queryType: v2
queries:
- name: p95
dataSource: apm_metrics
params:
env: <+probe.variables.ENV>
service: <+probe.variables.SERVICE_NAME>
stat: latency_p95
formula: p95*1000
aggregation: mean
runProperties:
timeout: 30s
interval: 5s
attempt: 1
pollingInterval: 30s
initialDelay: 1s
verbosity: debug
variables:
- name: SERVICE_NAME
value: <+input>
type: String
description: The name of the service to monitor.
required: true
- name: ENV
value: <+input>
type: String
description: The APM environment of the service to monitor.
required: false
In this example:
queryType: v2selects the Datadog v2 timeseries pathdataSource: apm_metricsqueries Datadog APM metrics for the target servicestat: latency_p95requests the P95 latency statisticformula: p95*1000converts seconds to milliseconds before comparisonaggregation: meanaverages datapoints across the lookback windowSERVICE_NAMEis required at runtime;ENVis optional and can be omitted when not needed
Multi-query metrics example
Use multiple named queries and a formula when validating a ratio or derived metric:
datadogApmProbeInputs:
connectorID: <+input>
durationInMin: 5
queryType: v2
queries:
- name: errors
dataSource: metrics
params:
query: sum:trace.servlet.request.errors{service:account-service}.as_count()
- name: hits
dataSource: metrics
params:
query: sum:trace.servlet.request.hits{service:account-service}.as_count()
formula: errors / hits
aggregation: mean
Probe YAML reference (v2)
apmProbe/inputs:
type: Datadog
comparator:
type: float
value: "500"
criteria: <=
datadogApmProbeInputs:
connectorID: my-datadog-connector
durationInMin: 5
queryType: v2
queries:
- name: p95
dataSource: apm_metrics
params:
service: cartservice
stat: latency_p95
env: production
formula: p95*1000
aggregation: mean
runProperties:
timeout: 30s
interval: 5s
attempt: 1
- The v2 path is selected when
queryTypeisv2or whenqueriesis populated. Legacy probes that use a singlequerystring continue to work without changes. - For
apm_metricsqueries,statis required. Optional parameters such asenvcan be left unset when not needed. - Synthetic test probes are evaluated in EOT mode only.