Type Members

1.  final case class ConstantSampler(decision: ConstantDecision = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ConstantSampler] with Product with Serializable

   Sampler that always makes a constant decision on span sampling.

   Sampler that always makes a constant decision on span sampling.

   Annotations

   @SerialVersionUID()

2.  final case class RateLimitingSampler(qps: Long = 0L, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[RateLimitingSampler] with Product with Serializable

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

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

   qps

   Rate per second.

   Annotations

   @SerialVersionUID()

3.  final case class ResourceSpans(resource: Option[Resource] = _root_.scala.None, scopeSpans: Seq[ScopeSpans] = _root_.scala.Seq.empty, instrumentationLibrarySpans: Seq[InstrumentationLibrarySpans] = _root_.scala.Seq.empty, schemaUrl: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ResourceSpans] with Product with Serializable

   A collection of ScopeSpans from a Resource.

   A collection of ScopeSpans from a Resource.

   resource

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

   scopeSpans

   A list of ScopeSpans that originate from a resource.

   instrumentationLibrarySpans

   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.

   schemaUrl

   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.

   Annotations

   @SerialVersionUID()

4.  final case class ScopeSpans(scope: Option[InstrumentationScope] = _root_.scala.None, spans: Seq[Span] = _root_.scala.Seq.empty, schemaUrl: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ScopeSpans] with Product with Serializable

   A collection of Spans produced by an InstrumentationScope.

   A collection of Spans produced by an InstrumentationScope.

   scope

   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).

   spans

   A list of Spans that originate from an instrumentation scope.

   schemaUrl

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

   Annotations

   @SerialVersionUID()

5.  final case class Span(traceId: ByteString = ..., spanId: ByteString = ..., traceState: String = "", parentSpanId: ByteString = ..., name: String = "", kind: SpanKind = ..., startTimeUnixNano: Long = 0L, endTimeUnixNano: Long = 0L, attributes: Seq[KeyValue] = _root_.scala.Seq.empty, droppedAttributesCount: Int = 0, events: Seq[Event] = _root_.scala.Seq.empty, droppedEventsCount: Int = 0, links: Seq[Link] = _root_.scala.Seq.empty, droppedLinksCount: Int = 0, status: Option[Status] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Span] with Product with Serializable

   Span represents a single operation within a trace.

   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.

   traceId

   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.

   spanId

   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.

   traceState

   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.

   parentSpanId

   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.

   name

   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.

   kind

   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.

   startTimeUnixNano

   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.

   endTimeUnixNano

   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.

   attributes

   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).

   droppedAttributesCount

   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.

   events

   events is a collection of Event items.

   droppedEventsCount

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

   links

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

   droppedLinksCount

   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.

   status

   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).

   Annotations

   @SerialVersionUID()

6.  final case class Status(message: String = "", code: StatusCode = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Status] with Product with Serializable

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

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

   message

   A developer-facing human readable error message.

   code

   The status code.

   Annotations

   @SerialVersionUID()

7.  final case class TraceConfig(sampler: Sampler = ..., maxNumberOfAttributes: Long = 0L, maxNumberOfTimedEvents: Long = 0L, maxNumberOfAttributesPerTimedEvent: Long = 0L, maxNumberOfLinks: Long = 0L, maxNumberOfAttributesPerLink: Long = 0L, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[TraceConfig] with Product with Serializable

   Global configuration of the trace service.

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

   maxNumberOfAttributes

   The global default max number of attributes per span.

   maxNumberOfTimedEvents

   The global default max number of annotation events per span.

   maxNumberOfAttributesPerTimedEvent

   The global default max number of attributes per timed event.

   maxNumberOfLinks

   The global default max number of link entries per span.

   maxNumberOfAttributesPerLink

   The global default max number of attributes per span.

   Annotations

   @SerialVersionUID()

8.  final case class TraceIdRatioBased(samplingRatio: Double = 0.0, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[TraceIdRatioBased] with Product with Serializable

   Sampler that tries to uniformly sample traces with a given ratio.

   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.

   samplingRatio

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

   Annotations

   @SerialVersionUID()

9.  final case class TracesData(resourceSpans: Seq[ResourceSpans] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[TracesData] with Product with Serializable

   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.

   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.

   resourceSpans

   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.

   Annotations

   @SerialVersionUID()

10.  final case class InstrumentationLibrarySpans(instrumentationLibrary: Option[InstrumentationLibrary] = _root_.scala.None, spans: Seq[Span] = _root_.scala.Seq.empty, schemaUrl: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[InstrumentationLibrarySpans] with Product with Serializable

    A collection of Spans produced by an InstrumentationLibrary.

    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.

    instrumentationLibrary

    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).

    spans

    A list of Spans that originate from an instrumentation library.

    schemaUrl

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

    Annotations

    @SerialVersionUID() @deprecated

    Deprecated

    (Since version ) Marked as deprecated in proto file