Table of contents

Setting up the OpenTelemetry collector

Using the OpenTelemetry collector is the best way to manage and route telemetry data to Checkly. It requires a little setting up, but it’s worth it.

• An OpenTelemetry collector running and configured.

If you need to set up OpenTelemetry for the first time, please use the Open Telemetry Collector getting started documentation.

Sending traces to Checkly is very simple with the OpenTelemetry collector. There are three sections you need to add to your collector configuration file:

1. Create a filter that will remove all spans that don’t have checkly=true in the trace state.
2. Create a new exporter with the Checkly API endpoint and API key as an environment variables.
3. Hook the exporter and filter into a new trace pipeline.

receivers:
  otlp:
    protocols:
      http:
      grpc:
processors:
  batch:
  filter/checkly:
    error_mode: ignore
    traces:
      span:
        # remove all spans that the trace state doesn't have an object
        # which key is "checkly" and value is "true"
        - 'trace_state["checkly"] != "true"'
exporters:
  otlp/checkly:
    endpoint: "otel.eu-west-1.checklyhq.com:4317"
    headers:
      authorization: "${env:CHECKLY_OTEL_API_KEY}"
service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [filter/checkly, batch]
      exporters: [otlp/checkly]

Grab your OTel API key in the Send traces section of the Open Telemetry Integration page in the Checkly app.
Now, export your API key in your shell by setting the CHECKLY_OTEL_API_KEY environment variable.

export CHECKLY_OTEL_API_KEY="<your-api-key>"

Now, restart your collector with the updated configuration file. If you are using a Dockerized version of the OTel collector, don’t forget to pass in the environment variables, e.g.

docker run \
-e CHECKLY_OTEL_API_KEY \
...

You are done. Any traces ingested by your collector that are triggered by a Checkly synthetic check will now be sent to Checkly via the new pipeline.

Send your traces to Checkly HTTP vs. gRPC OpenTelemetry protocols

Last updated on August 20, 2024. You can contribute to this documentation by editing this page on Github