Docs
Launch GraphOS Studio

OpenTelemetry Protocol (OTLP) exporter

Configure the OpenTelemetry Protocol (OTLP) exporter for metrics


Enable and configure the OpenTelemetry Protocol (OTLP) exporter for metrics in the .

For general metrics configuration, refer to Router Metrics Configuration.

Using the OTLP protocol, you can export metrics to any OTLP compatible receiver, including:

OTLP configuration

The can be configured to export metrics data using OTLP over either HTTP or gRPC.

An example configuration using OTLP with gRPC:

router.yaml
telemetry:
exporters:
metrics:
otlp:
# Enable the OpenTelemetry exporter
enabled: true
# Optional endpoint, either 'default' or a URL (Defaults to http://127.0.0.1:4317 for gRPC and http://127.0.0.1:4318 for HTTP)
endpoint: default
# Optional protocol
protocol: grpc
# Optional gRPC configuration
grpc:
metadata:
foo: bar
# Optional batch_processor configuration
batch_processor:
scheduled_delay: 100ms
max_concurrent_exports: 1000
max_export_batch_size: 10000
max_export_timeout: 100s
max_queue_size: 10000

enabled

Flag to enable the OTLP exporter.

Set to true to enable the OTLP exporter. Defaults to false.

endpoint

The OTLP endpoint address.

Defaults to:

grpc

Settings specific to the gRPC protocol for setting a custom SSL certificate, domain name, and metadata.

telemetry:
exporters:
tracing:
otlp:
grpc:
domain_name: "<my-domain>"
key: "<key>"
ca: "<certificate-authority>"
cert: "<certificate>"
metadata:
key1: value1
key2: value2

💡 TIP

Use the variable expansion feature for referencing environment variables and file paths in YAML configuration files. Use env. and file. prefixes, for example ${file.ca.txt}.

See gRPC Authentication for more information.

gRPC configuration reference

AttributeDescription
domain_nameAn optional domain name
keyAn optional key
caAn optional certificate authority
certAn optional certificate
metadataA map of headers to send with requests

http

Settings specific to the HTTP protocol for setting custom headers.

http:
headers:
key1: value1
key2: value2

HTTP configuration reference

AttributeDescription
headersA map of headers to send with requests

batch_processor

All exporters support configuration of a batch span processor with batch_processor.

You must tune your batch_processor configuration if you see any of the following messages in your logs:

  • OpenTelemetry trace error occurred: cannot send span to the batch span processor because the channel is full

  • OpenTelemetry metrics error occurred: cannot send span to the batch span processor because the channel is full

The exact settings depend on the bandwidth available for you to send data to your application peformance monitor (APM) and the bandwidth configuration of your APM. Expect to tune these settings over time as your application changes.

An example configuration using OTLP with batch_processor:

telemetry:
exporters:
metrics:
otlp:
batch_processor:
max_export_batch_size: 512
max_concurrent_exports: 1
max_export_timeout: 30s
max_queue_size: 2048
scheduled_delay: 5s

batch_processor configuration reference

AttributeDefaultDescription
scheduled_delay5sThe delay in seconds from receiving the first span to sending the batch.
max_concurrent_exports1The maximum number of overlapping export requests.
max_export_batch_size512The number of spans to include in a batch. May be limited by maximum message size limits.
max_export_timeout30sThe timeout in seconds for sending spans before dropping the data.
max_queue_size5The maximum number of spans to be buffered before dropping span data.

OTLP configuration reference

AttributeValuesDefaultDescription
enabledfalseEnable the OTLP exporter.
protocolgrpc|httpgrpcThe protocol to use.
endpointhttp://127.0.0.1:4317 for gRPC and http://127.0.0.1:4318 for HTTPThe endpoint to send spans to.
grpcConfiguration specific to gRPC protocol.
httpConfiguration specific to HTTP protocol.
temporarilitydelta|cumulativeSee the documentation for your APM to see what this should be set to.
Previous
New Relic
Next
Prometheus
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company