package opentelemetry.proto.trace.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Sampler that always makes a constant decision on span sampling.

Used in: TraceConfig

• ConstantSampler.ConstantDecision decision = 1

How spans should be sampled: - Always off - Always on - Always follow the parent Span's decision (off if no parent).

Used in: ConstantSampler

• ALWAYS_OFF = 0

• ALWAYS_ON = 1

• ALWAYS_PARENT = 2

A collection of Spans produced by an InstrumentationLibrary. InstrumentationLibrarySpans is wire-compatible with ScopeSpans for binary Protobuf format. This message is deprecated and will be removed on June 15, 2022.

Used in: ResourceSpans

• optional common.v1.InstrumentationLibrary instrumentation_library = 1

  The instrumentation library information for the spans in this message. Semantically when InstrumentationLibrary isn't set, it is equivalent with an empty instrumentation library name (unknown).

• repeated Span spans = 2

  A list of Spans that originate from an instrumentation library.

• string schema_url = 3

  This schema_url applies to all spans and span events in the "spans" field.

Sampler that tries to sample with a rate per time window.

Used in: TraceConfig

• int64 qps = 1

  Rate per second.

A collection of ScopeSpans from a Resource.

Used in: collector.trace.v1.ExportTraceServiceRequest, TracesData

• optional resource.v1.Resource resource = 1

  The resource for the spans in this message. If this field is not set then no resource info is known.

• repeated ScopeSpans scope_spans = 2

  A list of ScopeSpans that originate from a resource.

• repeated InstrumentationLibrarySpans instrumentation_library_spans = 1000

  A list of InstrumentationLibrarySpans that originate from a resource. This field is deprecated and will be removed after grace period expires on June 15, 2022. During the grace period the following rules SHOULD be followed: For Binary Protobufs ==================== Binary Protobuf senders SHOULD NOT set instrumentation_library_spans. Instead scope_spans SHOULD be set. Binary Protobuf receivers SHOULD check if instrumentation_library_spans is set and scope_spans is not set then the value in instrumentation_library_spans SHOULD be used instead by converting InstrumentationLibrarySpans into ScopeSpans. If scope_spans is set then instrumentation_library_spans SHOULD be ignored. For JSON ======== JSON senders that set instrumentation_library_spans field MAY also set scope_spans to carry the same spans, essentially double-publishing the same data. Such double-publishing MAY be controlled by a user-settable option. If double-publishing is not used then the senders SHOULD set scope_spans and SHOULD NOT set instrumentation_library_spans. JSON receivers SHOULD check if instrumentation_library_spans is set and scope_spans is not set then the value in instrumentation_library_spans SHOULD be used instead by converting InstrumentationLibrarySpans into ScopeSpans. If scope_spans is set then instrumentation_library_spans field SHOULD be ignored.

• string schema_url = 3

  This schema_url applies to the data in the "resource" field. It does not apply to the data in the "scope_spans" field which have their own schema_url field.

A collection of Spans produced by an InstrumentationScope.

Used in: ResourceSpans

• optional common.v1.InstrumentationScope scope = 1

  The instrumentation scope information for the spans in this message. Semantically when InstrumentationScope isn't set, it is equivalent with an empty instrumentation scope name (unknown).

• repeated Span spans = 2

  A list of Spans that originate from an instrumentation scope.

• string schema_url = 3

  This schema_url applies to all spans and span events in the "spans" field.

Span represents a single operation within a trace. Spans can be nested to form a trace tree. Spans may also be linked to other spans from the same or different trace and form graphs. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous - there may be gaps or overlaps between spans in a trace. The next available field id is 17.

Used in: InstrumentationLibrarySpans, ScopeSpans

• bytes trace_id = 1

  A unique identifier for a trace. All spans from the same trace share the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes is considered invalid. This field is semantically required. Receiver should generate new random trace_id if empty or invalid trace_id was received. This field is required.

• bytes span_id = 2

  A unique identifier for a span within a trace, assigned when the span is created. The ID is an 8-byte array. An ID with all zeroes is considered invalid. This field is semantically required. Receiver should generate new random span_id if empty or invalid span_id was received. This field is required.

• string trace_state = 3

  trace_state conveys information about request position in multiple distributed tracing graphs. It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header See also https://github.com/w3c/distributed-tracing for more details about this field.

• bytes parent_span_id = 4

  The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.

• string name = 5

  A description of the span's operation. For example, the name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name at the same call point in an application. This makes it easier to correlate spans in different traces. This field is semantically required to be set to non-empty string. Empty value is equivalent to an unknown span name. This field is required.

• Span.SpanKind kind = 6

  Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify queueing latency associated with the span.

• fixed64 start_time_unix_nano = 7

  start_time_unix_nano is the start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

• fixed64 end_time_unix_nano = 8

  end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

• repeated common.v1.KeyValue attributes = 9

  attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes: "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36" "/http/server_latency": 300 "abc.com/myattribute": true "abc.com/score": 10.239 The OpenTelemetry API specification further restricts the allowed value types: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attributes Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

• uint32 dropped_attributes_count = 10

  dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.

• repeated Span.Event events = 11

  events is a collection of Event items.

• uint32 dropped_events_count = 12

  dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.

• repeated Span.Link links = 13

  links is a collection of Links, which are references from this span to a span in the same or different trace.

• uint32 dropped_links_count = 14

  dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.

• optional Status status = 15

  An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).

Event is a time-stamped annotation of the span, consisting of user-supplied text description and key-value pairs.

Used in: Span

• fixed64 time_unix_nano = 1

  time_unix_nano is the time the event occurred.

• string name = 2

  name of the event. This field is semantically required to be set to non-empty string.

• repeated common.v1.KeyValue attributes = 3

  attributes is a collection of attribute key/value pairs on the event. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

• uint32 dropped_attributes_count = 4

  dropped_attributes_count is the number of dropped attributes. If the value is 0, then no attributes were dropped.

A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project.

Used in: Span

• bytes trace_id = 1

  A unique identifier of a trace that this linked span is part of. The ID is a 16-byte array.

• bytes span_id = 2

  A unique identifier for the linked span. The ID is an 8-byte array.

• string trace_state = 3

  The trace_state associated with the link.

• repeated common.v1.KeyValue attributes = 4

  attributes is a collection of attribute key/value pairs on the link. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

• uint32 dropped_attributes_count = 5

  dropped_attributes_count is the number of dropped attributes. If the value is 0, then no attributes were dropped.

SpanKind is the type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

Used in: Span

• SPAN_KIND_UNSPECIFIED = 0

  Unspecified. Do NOT use as default. Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.

• SPAN_KIND_INTERNAL = 1

  Indicates that the span represents an internal operation within an application, as opposed to an operation happening at the boundaries. Default value.

• SPAN_KIND_SERVER = 2

  Indicates that the span covers server-side handling of an RPC or other remote network request.

• SPAN_KIND_CLIENT = 3

  Indicates that the span describes a request to some remote service.

• SPAN_KIND_PRODUCER = 4

  Indicates that the span describes a producer sending a message to a broker. Unlike CLIENT and SERVER, there is often no direct critical path latency relationship between producer and consumer spans. A PRODUCER span ends when the message was accepted by the broker while the logical processing of the message might span a much longer time.

• SPAN_KIND_CONSUMER = 5

  Indicates that the span describes consumer receiving a message from a broker. Like the PRODUCER kind, there is often no direct critical path latency relationship between producer and consumer spans.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

Used in: Span

• string message = 2

  A developer-facing human readable error message.

• Status.StatusCode code = 3

  The status code.

For the semantics of status codes see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status

Used in: Status

• STATUS_CODE_UNSET = 0

  The default status.

• STATUS_CODE_OK = 1

  The Span has been validated by an Application developers or Operator to have completed successfully.

• STATUS_CODE_ERROR = 2

  The Span contains an error.

Global configuration of the trace service. All fields must be specified, or the default (zero) values will be used for each type.

• oneof sampler

  The global default sampler used to make decisions on span sampling.

  • ConstantSampler constant_sampler = 1

  • TraceIdRatioBased trace_id_ratio_based = 2

  • RateLimitingSampler rate_limiting_sampler = 3

• int64 max_number_of_attributes = 4

  The global default max number of attributes per span.

• int64 max_number_of_timed_events = 5

  The global default max number of annotation events per span.

• int64 max_number_of_attributes_per_timed_event = 6

  The global default max number of attributes per timed event.

• int64 max_number_of_links = 7

  The global default max number of link entries per span.

• int64 max_number_of_attributes_per_link = 8

  The global default max number of attributes per span.

Sampler that tries to uniformly sample traces with a given ratio. The ratio of sampling a trace is equal to that of the specified ratio.

Used in: TraceConfig

• double samplingRatio = 1

  The desired ratio of sampling. Must be within [0.0, 1.0].

TracesData represents the traces data that can be stored in a persistent storage, OR can be embedded by other protocols that transfer OTLP traces data but do not implement the OTLP protocol. The main difference between this message and collector protocol is that in this message there will not be any "control" or "metadata" specific to OTLP protocol. When new fields are added into this message, the OTLP request MUST be updated as well.

• repeated ResourceSpans resource_spans = 1

  An array of ResourceSpans. For data coming from a single resource this array will typically contain one element. Intermediary nodes that receive data from multiple origins typically batch the data before forwarding further and in that case this array will contain multiple elements.