Documentation
Start typing to search…

OpenTelemetry Collector

The OpenTelemetry Collector is a vendor-agnostic tool for receiving, processing, and exporting telemetry data to various open-source or commercial backends, including Lumigo.

This guide provides detailed instructions on configuring the OpenTelemetry Collector to report data to Lumigo. It also includes best practices for securing your Lumigo token.

📘

Note

Lumigo supports tracing for AWS Lambda functions through its dedicated tracers. For more information, refer to the AWS Lambda Tracing documentation. While OpenTelemetry can send tracing data from AWS Lambda to Lumigo, the data won't be marked as originating from a Lambda function or correlated with other Lambda-specific data collected by Lumigo.


Prerequisites

Before configuring the OpenTelemetry Collector, ensure the following:

  • You have a valid Lumigo token.
  • OpenTelemetry Collector is installed and accessible in your environment.
  • You have network access to the Lumigo OpenTelemetry endpoint.

1. Configure the OpenTelemetry Collector

To configure the OpenTelemetry Collector for Lumigo, you need to set up the Authorization HTTP header in the exporter that uploads data to the Lumigo OpenTelemetry endpoint.

Example configuration:

exporters:
  otlphttp/lumigo:
    endpoint: https://ga-otlp.lumigo-tracer-edge.golumigo.com
    headers:
      Authorization: LumigoToken <token>

service:
  pipelines:
    traces:
      exporters: [otlphttp/lumigo]

📘

Note

Pay close attention to the YAML indentation, as improper formatting can cause configuration errors.

For more information about authorization and the Lumigo OpenTelemetry endpoint, refer to the Lumigo OpenTelemetry Endpoint.

2. Secure Your Lumigo Token

To securely store and manage your Lumigo token, use environment variables supported by the OpenTelemetry Collector. This approach works well with platforms that allow secret management through environment variables, such as:

Assuming your Lumigo token is stored in the LUMIGO\_TOKEN environment variable, update the configuration as follows:

exporters:
  otlphttp/lumigo:
    endpoint: https://ga-otlp.lumigo-tracer-edge.golumigo.com
    headers:
      Authorization: LumigoToken ${LUMIGO_TOKEN}

service:
  pipelines:
    traces:
      exporters: [otlphttp/lumigo]

This method keeps your token secure by avoiding hardcoding sensitive information directly in configuration files.

Supported Semantic Conventions

Semantic Conventions standardize attribute naming across OpenTelemetry implementations. Lumigo supports the following Semantic Conventions:

These conventions provide consistent naming for operations and data types, ensuring better integration and data interpretation.

AWS Distro for OpenTelemetry

The AWS Distro for OpenTelemetry offers a version of the OpenTelemetry Collector that can send trace data to Lumigo.

The AWS Distro for OpenTelemetry is an AWS-supported distribution of the OpenTelemetry Collector that is compatible with Lumigo for sending trace data.

Integrating with Quarkus.io

Quarkus.io provides an OpenTelemetry Extension that sends trace data using the OTLP/gRPC protocol.

Compatibility

Lumigo currently supports the OTLP/HTTP protocol. As the Quarkus OpenTelemetry extension does not yet support OTLP/HTTP , the recommended configuration is as follows:

  1. Send trace data from your Quarkus application to an OpenTelemetry Collector.
  2. Configure the OpenTelemetry Collector to forward the data to Lumigo.

This setup ensures compatibility and seamless trace data ingestion into Lumigo.

Updated 3 months ago