This check collects distributed system observability metrics from Linkerd.
The Linkerd check is included in the Datadog Agent package, so you don't need to install anything else on your server.
Follow the instructions below to configure this check for an Agent running on a host. For containerized environments, see the Containerized section.
-
Edit the
linkerd.d/conf.yamlfile, in theconf.d/folder at the root of your Agent's configuration directory. See sample linkerd.d/conf.yaml for all available configuration options.
For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.
| Parameter | Value |
|---|---|
<INTEGRATION_NAME> |
linkerd |
<INIT_CONFIG> |
blank or {} |
<INSTANCE_CONFIG> |
{"prometheus_url": "http://%%host%%:9990/admin/metrics/prometheus"} |
| Parameter | Value |
|---|---|
<INTEGRATION_NAME> |
linkerd |
<INIT_CONFIG> |
blank or {} |
<INSTANCE_CONFIG> |
{"prometheus_url": "http://%%host%%:4191/metrics"} |
Run the Agent's status subcommand and look for linkerd under the Checks section.
See metadata.csv for a list of default metrics provided by this integration.
For linkerd v1, see finagle metrics docs for a detailed description of some of the available metrics and this gist for an example of metrics exposed by linkerd.
Attention: Depending on your linkerd configuration, some metrics might not be exposed by linkerd.
To list the metrics exposed by your current configuration, run
curl <linkerd_prometheus_endpoint>Where linkerd_prometheus_endpoint is the linkerd prometheus endpoint (you should use the same value as the prometheus_url config key in your linkerd.yaml)
If you need to use a metric that is not provided by default, you can add an entry to linkerd.yaml.
Simply follow the examples present in the default configuration.
linkerd.prometheus.health:
Returns CRITICAL if the Agent fails to connect to the prometheus endpoint, otherwise returns UP.
Need help? Contact Datadog support.