OTLP in Monium

Monium can receive metrics via OTLP (OpenTelemetry Protocol), which allows you to send telemetry directly from applications using the OpenTelemetry SDK or through the OpenTelemetry Collector.

EndpointsEndpoints

Monium provides the following endpoints for receiving metrics in OTLP format:

The gRPC and HTTP endpoints are fully compatible with the OTLP specification.

AuthorizationAuthorization

Requests are authorized using an API key provided in the Authorization header:

Authorization: Api-Key <API_key>

The API key is created for a service account with the monium.telemetry.writer role. The key must have the yc.monium.telemetry.write scope to write any type of telemetry or one or more of the following for granular access: yc.monium.metrics.write, yc.monium.logs.write, yc.monium.traces.write. Learn more about creating an API key.

HeadingsHeadings

Required headersRequired headers

Optional headersOptional headers

Distribution by shardsDistribution by shards

All metrics, logs, and traces in Monium have mandatory labels: project, cluster, and service. These labels form the shard key.

When delivering telemetry in OpenTelemetry format, the values of these key attributes are determined as follows:

1. Highest priority: Values set via HTTP or gRPC headers.
2. Then, the values set in the resource attributes of the request body with the cluster and service keys.
3. Then, the values set in the resource attributes recommended by the OpenTelemetry semantic convention.
4. Otherwise, a default value is assigned.

The project name is only taken from the header. The algorithm for determining the shard key is presented in the table below.

Learn more about sharding parameters in Basic terms.

Data compressionData compression

Realtime API supports the following compression types:

Metric type mappingMetric type mapping

This section maps OpenTelemetry data types to Monium types.

OTLP metric typesOTLP metric types

OpenTelemetry uses the following metric types:

Monium type mappingMonium type mapping

Monium converts OTLP types into its internal metric types depending on temporality:

Temporality = DeltaTemporality = Delta

Temporality = CumulativeTemporality = Cumulative

Examples of sum processingExamples of sum processing

Cumulative SumCumulative Sum

Delta Sum, MonotonicDelta Sum, Monotonic

Non-monotonic delta sums are typically not used in OpenTelemetry.

Processing resource attributesProcessing resource attributes

Monium processes OTLP resource attributes as follows:

Preserved attributesPreserved attributes

The following resource attributes are preserved as metric labels:

Host attributes (prioritized from highest to lowest):

• host
• host.name
• hostname

These attributes are saved under the host label.

Environment attributes (prioritized from highest to lowest):

• env
• deployment.environment.name
• deployment.environment

These attributes are saved under the env label.

Kubernetes and Cloud attributes (saved without renaming):

• cloud.availability_zone
• cloud.region
• container.name
• k8s.cluster.name
• k8s.container.name
• k8s.cronjob.name
• k8s.daemonset.name
• k8s.deployment.name
• k8s.job.name
• k8s.namespace.name
• k8s.pod.name
• k8s.replicaset.name
• k8s.statefulset.name

Reserved labelsReserved labels

If data point attributes use reserved label names, they are automatically renamed:

Other attributesOther attributes

Resource attributes not listed above are discarded.
All data point attributes are preserved as Monium metric labels.

Data formatData format

Monium supports the OTLP Protobuf format for all types of telemetry. The OTLP JSON format is currently supported for logs and traces.

See alsoSee also

• SDKs for data transmission in OpenTelemetry format
• Data transmission via OpenTelemetry Collector
• OTLP specification
• OpenTelemetry Metrics