package v1

Import Path
	go.opentelemetry.io/proto/otlp/trace/v1 (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 4 packages

Involved Source Files trace.pb.go
Package-Level Type Names (total 10)
/* sort by: | */
A collection of ScopeSpans from a Resource. The resource for the spans in this message. If this field is not set then no resource info is known. The Schema URL, if known. This is the identifier of the Schema that the resource data is recorded in. Notably, the last part of the URL path is the version number of the schema: http[s]://server[:port]/path/<version>. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url 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 list of ScopeSpans that originate from a resource. Deprecated: Use ResourceSpans.ProtoReflect.Descriptor instead. (*ResourceSpans) GetResource() *v1.Resource (*ResourceSpans) GetSchemaUrl() string (*ResourceSpans) GetScopeSpans() []*ScopeSpans (*ResourceSpans) ProtoMessage() (*ResourceSpans) ProtoReflect() protoreflect.Message (*ResourceSpans) Reset() (*ResourceSpans) String() string *ResourceSpans : expvar.Var *ResourceSpans : fmt.Stringer *ResourceSpans : github.com/gogo/protobuf/proto.Message *ResourceSpans : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *ResourceSpans : google.golang.org/protobuf/runtime/protoiface.MessageV1 func (*TracesData).GetResourceSpans() []*ResourceSpans func go.opentelemetry.io/proto/otlp/collector/trace/v1.(*ExportTraceServiceRequest).GetResourceSpans() []*ResourceSpans func go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/tracetransform.Spans(sdl []tracesdk.ReadOnlySpan) []*ResourceSpans func go.opentelemetry.io/otel/exporters/otlp/otlptrace.Client.UploadTraces(ctx context.Context, protoSpans []*ResourceSpans) error
A collection of Spans produced by an InstrumentationScope. The Schema URL, if known. This is the identifier of the Schema that the span data is recorded in. Notably, the last part of the URL path is the version number of the schema: http[s]://server[:port]/path/<version>. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url This schema_url applies to all spans and span events in the "spans" field. 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). A list of Spans that originate from an instrumentation scope. Deprecated: Use ScopeSpans.ProtoReflect.Descriptor instead. (*ScopeSpans) GetSchemaUrl() string (*ScopeSpans) GetScope() *v11.InstrumentationScope (*ScopeSpans) GetSpans() []*Span (*ScopeSpans) ProtoMessage() (*ScopeSpans) ProtoReflect() protoreflect.Message (*ScopeSpans) Reset() (*ScopeSpans) String() string *ScopeSpans : expvar.Var *ScopeSpans : fmt.Stringer *ScopeSpans : github.com/gogo/protobuf/proto.Message *ScopeSpans : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *ScopeSpans : google.golang.org/protobuf/runtime/protoiface.MessageV1 func (*ResourceSpans).GetScopeSpans() []*ScopeSpans
A Span represents a single operation performed by a single component of the system. The next available field id is 17. 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 "example.com/myattribute": true "example.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/README.md#attribute Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key). 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. dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped. 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. 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. events is a collection of Event items. Flags, a bit field. Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace Context specification. To read the 8-bit W3C trace flag, use `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`. See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions. Bits 8 and 9 represent the 3 states of whether a span's parent is remote. The states are (unknown, is not remote, is remote). To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`. To read whether the span is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`. When creating span messages, if the message is logically forwarded from another source with an equivalent flags fields (i.e., usually another OTLP span message), the field SHOULD be copied as-is. If creating from a source that does not have an equivalent flags field (such as a runtime representation of an OpenTelemetry span), the high 22 bits MUST be set to zero. Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero. [Optional]. 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. links is a collection of Links, which are references from this span to a span in the same or different trace. 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. 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. 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 OR of length other than 8 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid). This field is required. 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. 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). 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 OR of length other than 16 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid). This field is required. 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. Deprecated: Use Span.ProtoReflect.Descriptor instead. (*Span) GetAttributes() []*v11.KeyValue (*Span) GetDroppedAttributesCount() uint32 (*Span) GetDroppedEventsCount() uint32 (*Span) GetDroppedLinksCount() uint32 (*Span) GetEndTimeUnixNano() uint64 (*Span) GetEvents() []*Span_Event (*Span) GetFlags() uint32 (*Span) GetKind() Span_SpanKind (*Span) GetLinks() []*Span_Link (*Span) GetName() string (*Span) GetParentSpanId() []byte (*Span) GetSpanId() []byte (*Span) GetStartTimeUnixNano() uint64 (*Span) GetStatus() *Status (*Span) GetTraceId() []byte (*Span) GetTraceState() string (*Span) ProtoMessage() (*Span) ProtoReflect() protoreflect.Message (*Span) Reset() (*Span) String() string *Span : expvar.Var *Span : fmt.Stringer *Span : github.com/gogo/protobuf/proto.Message *Span : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *Span : google.golang.org/protobuf/runtime/protoiface.MessageV1 func (*ScopeSpans).GetSpans() []*Span
Event is a time-stamped annotation of the span, consisting of user-supplied text description and key-value pairs. 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). dropped_attributes_count is the number of dropped attributes. If the value is 0, then no attributes were dropped. name of the event. This field is semantically required to be set to non-empty string. time_unix_nano is the time the event occurred. Deprecated: Use Span_Event.ProtoReflect.Descriptor instead. (*Span_Event) GetAttributes() []*v11.KeyValue (*Span_Event) GetDroppedAttributesCount() uint32 (*Span_Event) GetName() string (*Span_Event) GetTimeUnixNano() uint64 (*Span_Event) ProtoMessage() (*Span_Event) ProtoReflect() protoreflect.Message (*Span_Event) Reset() (*Span_Event) String() string *Span_Event : expvar.Var *Span_Event : fmt.Stringer *Span_Event : github.com/gogo/protobuf/proto.Message *Span_Event : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *Span_Event : google.golang.org/protobuf/runtime/protoiface.MessageV1 func (*Span).GetEvents() []*Span_Event
SpanKind is the type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship. ( Span_SpanKind) Descriptor() protoreflect.EnumDescriptor ( Span_SpanKind) Enum() *Span_SpanKind Deprecated: Use Span_SpanKind.Descriptor instead. ( Span_SpanKind) Number() protoreflect.EnumNumber ( Span_SpanKind) String() string ( Span_SpanKind) Type() protoreflect.EnumType Span_SpanKind : expvar.Var Span_SpanKind : fmt.Stringer Span_SpanKind : google.golang.org/protobuf/reflect/protoreflect.Enum func (*Span).GetKind() Span_SpanKind func Span_SpanKind.Enum() *Span_SpanKind const Span_SPAN_KIND_CLIENT const Span_SPAN_KIND_CONSUMER const Span_SPAN_KIND_INTERNAL const Span_SPAN_KIND_PRODUCER const Span_SPAN_KIND_SERVER const Span_SPAN_KIND_UNSPECIFIED
SpanFlags represents constants used to interpret the Span.flags field, which is protobuf 'fixed32' type and is to be used as bit-fields. Each non-zero value defined in this enum is a bit-mask. To extract the bit-field, for example, use an expression like: (span.flags & SPAN_FLAGS_TRACE_FLAGS_MASK) See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions. Note that Span flags were introduced in version 1.1 of the OpenTelemetry protocol. Older Span producers do not set this field, consequently consumers should not rely on the absence of a particular flag bit to indicate the presence of a particular feature. ( SpanFlags) Descriptor() protoreflect.EnumDescriptor ( SpanFlags) Enum() *SpanFlags Deprecated: Use SpanFlags.Descriptor instead. ( SpanFlags) Number() protoreflect.EnumNumber ( SpanFlags) String() string ( SpanFlags) Type() protoreflect.EnumType SpanFlags : expvar.Var SpanFlags : fmt.Stringer SpanFlags : google.golang.org/protobuf/reflect/protoreflect.Enum func SpanFlags.Enum() *SpanFlags const SpanFlags_SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK const SpanFlags_SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK const SpanFlags_SPAN_FLAGS_DO_NOT_USE const SpanFlags_SPAN_FLAGS_TRACE_FLAGS_MASK
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. The status code. A developer-facing human readable error message. Deprecated: Use Status.ProtoReflect.Descriptor instead. (*Status) GetCode() Status_StatusCode (*Status) GetMessage() string (*Status) ProtoMessage() (*Status) ProtoReflect() protoreflect.Message (*Status) Reset() (*Status) String() string *Status : expvar.Var *Status : fmt.Stringer *Status : github.com/gogo/protobuf/proto.Message *Status : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *Status : google.golang.org/protobuf/runtime/protoiface.MessageV1 func (*Span).GetStatus() *Status
For the semantics of status codes see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status ( Status_StatusCode) Descriptor() protoreflect.EnumDescriptor ( Status_StatusCode) Enum() *Status_StatusCode Deprecated: Use Status_StatusCode.Descriptor instead. ( Status_StatusCode) Number() protoreflect.EnumNumber ( Status_StatusCode) String() string ( Status_StatusCode) Type() protoreflect.EnumType Status_StatusCode : expvar.Var Status_StatusCode : fmt.Stringer Status_StatusCode : google.golang.org/protobuf/reflect/protoreflect.Enum func (*Status).GetCode() Status_StatusCode func Status_StatusCode.Enum() *Status_StatusCode const Status_STATUS_CODE_ERROR const Status_STATUS_CODE_OK const Status_STATUS_CODE_UNSET
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. 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. Deprecated: Use TracesData.ProtoReflect.Descriptor instead. (*TracesData) GetResourceSpans() []*ResourceSpans (*TracesData) ProtoMessage() (*TracesData) ProtoReflect() protoreflect.Message (*TracesData) Reset() (*TracesData) String() string *TracesData : expvar.Var *TracesData : fmt.Stringer *TracesData : github.com/gogo/protobuf/proto.Message *TracesData : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *TracesData : google.golang.org/protobuf/runtime/protoiface.MessageV1
Package-Level Variables (total 7)
Enum value maps for Span_SpanKind.
Enum value maps for Span_SpanKind.
Enum value maps for SpanFlags.
Enum value maps for SpanFlags.
Enum value maps for Status_StatusCode.
Enum value maps for Status_StatusCode.
Package-Level Constants (total 13)
Indicates that the span describes a request to some remote service.
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.
Indicates that the span represents an internal operation within an application, as opposed to an operation happening at the boundaries. Default value.
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.
Indicates that the span covers server-side handling of an RPC or other remote network request.
Unspecified. Do NOT use as default. Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.
Bits 8 and 9 are used to indicate that the parent span or link span is remote. Bit 8 (`HAS_IS_REMOTE`) indicates whether the value is known. Bit 9 (`IS_REMOTE`) indicates whether the span or link is remote.
The zero value for the enum. Should not be used for comparisons. Instead use bitwise "and" with the appropriate mask as shown above.
Bits 0-7 are used for trace flags.
The Span contains an error.
The Span has been validated by an Application developer or Operator to have completed successfully.
The default status.