Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 2.85 KB

jaeger.md

File metadata and controls

68 lines (44 loc) · 2.85 KB

OpenTelemetry to Jaeger Transformation

This document defines the transformation between OpenTelemetry and Jaeger Spans. Jaeger's v2 API is defined in the jaeger model.proto

Summary

The following table summarizes the major transformations between OpenTelemetry and Jaeger.

TBD

Mappings

This section discusses the details of the transformations between OpenTelemetry and Jaeger.

Resource

OpenTelemetry resources MUST be mapped to Jaeger's Span.Process tags. Multiple resources can exist for a single process and exporters need to handle this case accordingly.

Critically, Jaeger backend depends on Span.Process.ServiceName to identify the service that produced the spans. That field MUST be populated from the service.name attribute of the service resource.

InstrumentationLibrary

OpenTelemetry Span's InstrumentationLibrary MUST be reported as span tags to Jaeger using the following mapping.

OpenTelemetry Jaeger
InstrumentationLibrary.name otel.library.name
InstrumentationLibrary.version otel.library.version

Attribute

TBD

Status

Span Status MUST be reported as a key-value pair in tags to Jaeger, unless it is UNSET. In the latter case it MUST NOT be reported.

The following table defines the OpenTelemetry Status to Jaeger tags mapping.

Status Tag Key Tag Value
Code otel.status_code Name of the code, either OK or ERROR. MUST NOT be set if the code is UNSET.
Description otel.status_description Description of the Status if it has a value otherwise not set.

Error flag

When Span Status is set to ERROR an error tag MUST be added with the Boolean value of true. The added error tag MAY override any previous value.

Events

Events MUST be converted to Jaeger Logs. OpenTelemetry Event's time_unix_nano and attributes fields map directly to Jaeger Log's timestamp and fields fields. Jaeger Log has no direct equivalent for OpenTelemetry Event's name and dropped_attributes_count fields but OpenTracing semantic conventions specify some special attribute names here. OpenTelemetry Event's name and dropped_attributes_count fields should be added to Jaeger Log's fields map as follows:

OpenTelemetry Event Field Jaeger Attribute
name event
dropped_attributes_count otel.event.dropped_attributes_count
  • dropped_attributes_count should only be recorded when it contains a non-zero value.
  • If OpenTelemetry Event contains an attributes with the key event, it should take precedence over Event's name field.