The Service Map for APM is here!

Linkerd

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

This check collects distributed system observability metrics from Linkerd.

Setup

Installation

The Linkerd check is included in the Datadog Agent package, so you don’t need to install anything else on your server.

Configuration

Edit the linkerd.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory. See sample linkerd.d/conf.yaml for all available configuration options.

Validation

Run the Agent’s status subcommand and look for linkerd under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of default metrics provided by this integration.

See finagle metrics docs for a detailed description of some of the available metrics. See 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.

Service Checks

linkerd.prometheus.health: Returns CRITICAL if the Agent fails to connect to the prometheus endpoint, otherwise returns UP.

Troubleshooting

Need help? Contact Datadog Support.


Mistake in the docs? Feel free to contribute!