OpenTelemetryΒΆ

Endpoint

otel

URL

https://${OBSERVE_CUSTOMER}.collect.observeinc.com/v1/otel

Maximum Request Size (compressed)

10MB

Maximum Request Size (uncompressed)

50MB

Global Individual Observation Limit

4MB

OpenTelemetry is an observability framework provided by the Open Source community to make it easier to ingest all aspects of Application performance monitoring (APM). For most collector configurations, use the otlphttp exporter.

Observe implements the write-only endpoint for OpenTelemetry as defined by the OpenTelemetry Protocol Definition and allows the collector to support the following observation types:

Type

URL Suffix

Protocol Status

Traces

v1/traces

stable

Metrics

v1/metrics

stable

Logs

v1/logs

stable

The request body should be encoded in the Protobuf format and sent with the content-type application/x-protobuf. GRPC ingestion is not supported for the OpenTelemetry endpoint. If you would like to use GRPC, please refer to the OpenTelemetry Collector forwarder documentation.

Observe recommends using the opentelemetry-collector or opentelemetry-collector-contrib for ingesting data of these types. To send data using the collector, you need to authenticate with the collector using a Datastream Token attached as an http authorization header. Use the otlphttp exporter and adding the following block of code to your YAML file:

headers:
      'Authorization': 'Bearer ${OBSERVE_TOKEN}'

For information on configuring the collectors, see Configuring the OpenTelemetry Collector.

If you want to bypass the OpenTelemetry collector and test the endpoint directly, you must specify the URL and the relevant suffix. For instance, traces should be sent to the following URL:

https://${OBSERVE_CUSTOMERID}.collect.observeinc.com/v1/otel/v1/traces

Again, you need an Observe token for authentication as in this example:

https://${OBSERVE_CUSTOMERID}.collect.observeinc.com/v1/otel/v1/traces \
-H "Authorization: Bearer ab1cdE2FGhiJKlmnop34Q:rstUv5w6Xy7z8AB_CdeFg9h0iJK1mnOPqr" \
-d @sample_trace.json