v1

package
v0.19.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 12, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Span_SpanKind_name = map[int32]string{
		0: "SPAN_KIND_UNSPECIFIED",
		1: "SPAN_KIND_INTERNAL",
		2: "SPAN_KIND_SERVER",
		3: "SPAN_KIND_CLIENT",
		4: "SPAN_KIND_PRODUCER",
		5: "SPAN_KIND_CONSUMER",
	}
	Span_SpanKind_value = map[string]int32{
		"SPAN_KIND_UNSPECIFIED": 0,
		"SPAN_KIND_INTERNAL":    1,
		"SPAN_KIND_SERVER":      2,
		"SPAN_KIND_CLIENT":      3,
		"SPAN_KIND_PRODUCER":    4,
		"SPAN_KIND_CONSUMER":    5,
	}
)

Enum value maps for Span_SpanKind.

View Source 
var (
	Status_StatusCode_name = map[int32]string{
		0: "STATUS_CODE_UNSET",
		1: "STATUS_CODE_OK",
		2: "STATUS_CODE_ERROR",
	}
	Status_StatusCode_value = map[string]int32{
		"STATUS_CODE_UNSET": 0,
		"STATUS_CODE_OK":    1,
		"STATUS_CODE_ERROR": 2,
	}
)

Enum value maps for Status_StatusCode.

View Source 
var File_opentelemetry_proto_trace_v1_trace_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ResourceSpans 

type ResourceSpans struct {

	// The resource for the spans in this message.
	// If this field is not set then no resource info is known.
	Resource *v1.Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// A list of ScopeSpans that originate from a resource.
	ScopeSpans []*ScopeSpans `protobuf:"bytes,2,rep,name=scope_spans,json=scopeSpans,proto3" json:"scope_spans,omitempty"`
	// 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.
	SchemaUrl string `protobuf:"bytes,3,opt,name=schema_url,json=schemaUrl,proto3" json:"schema_url,omitempty"`
	// contains filtered or unexported fields
}

A collection of ScopeSpans from a Resource.

func (*ResourceSpans) Descriptor deprecated 

func (*ResourceSpans) Descriptor() ([]byte, []int)

Deprecated: Use ResourceSpans.ProtoReflect.Descriptor instead.

func (*ResourceSpans) GetResource 

func (x *ResourceSpans) GetResource() *v1.Resource

func (*ResourceSpans) GetSchemaUrl 

func (x *ResourceSpans) GetSchemaUrl() string

func (*ResourceSpans) GetScopeSpans 

func (x *ResourceSpans) GetScopeSpans() []*ScopeSpans

func (*ResourceSpans) ProtoMessage 

func (*ResourceSpans) ProtoMessage()

func (*ResourceSpans) ProtoReflect 

func (x *ResourceSpans) ProtoReflect() protoreflect.Message

func (*ResourceSpans) Reset 

func (x *ResourceSpans) Reset()

func (*ResourceSpans) String 

func (x *ResourceSpans) String() string

type ScopeSpans 

type ScopeSpans struct {

	// 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).
	Scope *v11.InstrumentationScope `protobuf:"bytes,1,opt,name=scope,proto3" json:"scope,omitempty"`
	// A list of Spans that originate from an instrumentation scope.
	Spans []*Span `protobuf:"bytes,2,rep,name=spans,proto3" json:"spans,omitempty"`
	// This schema_url applies to all spans and span events in the "spans" field.
	SchemaUrl string `protobuf:"bytes,3,opt,name=schema_url,json=schemaUrl,proto3" json:"schema_url,omitempty"`
	// contains filtered or unexported fields
}

A collection of Spans produced by an InstrumentationScope.

func (*ScopeSpans) Descriptor deprecated 

func (*ScopeSpans) Descriptor() ([]byte, []int)

Deprecated: Use ScopeSpans.ProtoReflect.Descriptor instead.

func (*ScopeSpans) GetSchemaUrl 

func (x *ScopeSpans) GetSchemaUrl() string

func (*ScopeSpans) GetScope 

func (x *ScopeSpans) GetScope() *v11.InstrumentationScope

func (*ScopeSpans) GetSpans 

func (x *ScopeSpans) GetSpans() []*Span

func (*ScopeSpans) ProtoMessage 

func (*ScopeSpans) ProtoMessage()

func (*ScopeSpans) ProtoReflect 

func (x *ScopeSpans) ProtoReflect() protoreflect.Message

func (*ScopeSpans) Reset 

func (x *ScopeSpans) Reset()

func (*ScopeSpans) String 

func (x *ScopeSpans) String() string

type Span 

type Span struct {

	// 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.
	TraceId []byte `protobuf:"bytes,1,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	// 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.
	SpanId []byte `protobuf:"bytes,2,opt,name=span_id,json=spanId,proto3" json:"span_id,omitempty"`
	// 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.
	TraceState string `protobuf:"bytes,3,opt,name=trace_state,json=traceState,proto3" json:"trace_state,omitempty"`
	// 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.
	ParentSpanId []byte `protobuf:"bytes,4,opt,name=parent_span_id,json=parentSpanId,proto3" json:"parent_span_id,omitempty"`
	// 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.
	Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
	// 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.
	Kind Span_SpanKind `protobuf:"varint,6,opt,name=kind,proto3,enum=opentelemetry.proto.trace.v1.Span_SpanKind" json:"kind,omitempty"`
	// 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.
	StartTimeUnixNano uint64 `protobuf:"fixed64,7,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// 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.
	EndTimeUnixNano uint64 `protobuf:"fixed64,8,opt,name=end_time_unix_nano,json=endTimeUnixNano,proto3" json:"end_time_unix_nano,omitempty"`
	// 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/README.md#attribute
	// Attribute keys MUST be unique (it is not allowed to have more than one
	// attribute with the same key).
	Attributes []*v11.KeyValue `protobuf:"bytes,9,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// 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.
	DroppedAttributesCount uint32 `` /* 131-byte string literal not displayed */
	// events is a collection of Event items.
	Events []*Span_Event `protobuf:"bytes,11,rep,name=events,proto3" json:"events,omitempty"`
	// dropped_events_count is the number of dropped events. If the value is 0, then no
	// events were dropped.
	DroppedEventsCount uint32 `protobuf:"varint,12,opt,name=dropped_events_count,json=droppedEventsCount,proto3" json:"dropped_events_count,omitempty"`
	// links is a collection of Links, which are references from this span to a span
	// in the same or different trace.
	Links []*Span_Link `protobuf:"bytes,13,rep,name=links,proto3" json:"links,omitempty"`
	// 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.
	DroppedLinksCount uint32 `protobuf:"varint,14,opt,name=dropped_links_count,json=droppedLinksCount,proto3" json:"dropped_links_count,omitempty"`
	// 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).
	Status *Status `protobuf:"bytes,15,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

A Span represents a single operation performed by a single component of the system.

The next available field id is 17.

func (*Span) Descriptor deprecated 

func (*Span) Descriptor() ([]byte, []int)

Deprecated: Use Span.ProtoReflect.Descriptor instead.

func (*Span) GetAttributes 

func (x *Span) GetAttributes() []*v11.KeyValue

func (*Span) GetDroppedAttributesCount 

func (x *Span) GetDroppedAttributesCount() uint32

func (*Span) GetDroppedEventsCount 

func (x *Span) GetDroppedEventsCount() uint32

func (*Span) GetDroppedLinksCount 

func (x *Span) GetDroppedLinksCount() uint32

func (*Span) GetEndTimeUnixNano 

func (x *Span) GetEndTimeUnixNano() uint64

func (*Span) GetEvents 

func (x *Span) GetEvents() []*Span_Event

func (*Span) GetKind 

func (x *Span) GetKind() Span_SpanKind
func (x *Span) GetLinks() []*Span_Link

func (*Span) GetName 

func (x *Span) GetName() string

func (*Span) GetParentSpanId 

func (x *Span) GetParentSpanId() []byte

func (*Span) GetSpanId 

func (x *Span) GetSpanId() []byte

func (*Span) GetStartTimeUnixNano 

func (x *Span) GetStartTimeUnixNano() uint64

func (*Span) GetStatus 

func (x *Span) GetStatus() *Status

func (*Span) GetTraceId 

func (x *Span) GetTraceId() []byte

func (*Span) GetTraceState 

func (x *Span) GetTraceState() string

func (*Span) ProtoMessage 

func (*Span) ProtoMessage()

func (*Span) ProtoReflect 

func (x *Span) ProtoReflect() protoreflect.Message

func (*Span) Reset 

func (x *Span) Reset()

func (*Span) String 

func (x *Span) String() string

type Span_Event 

type Span_Event struct {

	// time_unix_nano is the time the event occurred.
	TimeUnixNano uint64 `protobuf:"fixed64,1,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// name of the event.
	// This field is semantically required to be set to non-empty string.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// 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).
	Attributes []*v11.KeyValue `protobuf:"bytes,3,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// dropped_attributes_count is the number of dropped attributes. If the value is 0,
	// then no attributes were dropped.
	DroppedAttributesCount uint32 `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*Span_Event) Descriptor deprecated 

func (*Span_Event) Descriptor() ([]byte, []int)

Deprecated: Use Span_Event.ProtoReflect.Descriptor instead.

func (*Span_Event) GetAttributes 

func (x *Span_Event) GetAttributes() []*v11.KeyValue

func (*Span_Event) GetDroppedAttributesCount 

func (x *Span_Event) GetDroppedAttributesCount() uint32

func (*Span_Event) GetName 

func (x *Span_Event) GetName() string

func (*Span_Event) GetTimeUnixNano 

func (x *Span_Event) GetTimeUnixNano() uint64

func (*Span_Event) ProtoMessage 

func (*Span_Event) ProtoMessage()

func (*Span_Event) ProtoReflect 

func (x *Span_Event) ProtoReflect() protoreflect.Message

func (*Span_Event) Reset 

func (x *Span_Event) Reset()

func (*Span_Event) String 

func (x *Span_Event) String() string
type Span_Link struct {

	// A unique identifier of a trace that this linked span is part of. The ID is a
	// 16-byte array.
	TraceId []byte `protobuf:"bytes,1,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	// A unique identifier for the linked span. The ID is an 8-byte array.
	SpanId []byte `protobuf:"bytes,2,opt,name=span_id,json=spanId,proto3" json:"span_id,omitempty"`
	// The trace_state associated with the link.
	TraceState string `protobuf:"bytes,3,opt,name=trace_state,json=traceState,proto3" json:"trace_state,omitempty"`
	// 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).
	Attributes []*v11.KeyValue `protobuf:"bytes,4,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// dropped_attributes_count is the number of dropped attributes. If the value is 0,
	// then no attributes were dropped.
	DroppedAttributesCount uint32 `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*Span_Link) Descriptor deprecated 

func (*Span_Link) Descriptor() ([]byte, []int)

Deprecated: Use Span_Link.ProtoReflect.Descriptor instead.

func (*Span_Link) GetAttributes 

func (x *Span_Link) GetAttributes() []*v11.KeyValue

func (*Span_Link) GetDroppedAttributesCount 

func (x *Span_Link) GetDroppedAttributesCount() uint32

func (*Span_Link) GetSpanId 

func (x *Span_Link) GetSpanId() []byte

func (*Span_Link) GetTraceId 

func (x *Span_Link) GetTraceId() []byte

func (*Span_Link) GetTraceState 

func (x *Span_Link) GetTraceState() string

func (*Span_Link) ProtoMessage 

func (*Span_Link) ProtoMessage()

func (*Span_Link) ProtoReflect 

func (x *Span_Link) ProtoReflect() protoreflect.Message

func (*Span_Link) Reset 

func (x *Span_Link) Reset()

func (*Span_Link) String 

func (x *Span_Link) String() string

type Span_SpanKind 

type Span_SpanKind int32

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

const (
	// Unspecified. Do NOT use as default.
	// Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.
	Span_SPAN_KIND_UNSPECIFIED Span_SpanKind = 0
	// Indicates that the span represents an internal operation within an application,
	// as opposed to an operation happening at the boundaries. Default value.
	Span_SPAN_KIND_INTERNAL Span_SpanKind = 1
	// Indicates that the span covers server-side handling of an RPC or other
	// remote network request.
	Span_SPAN_KIND_SERVER Span_SpanKind = 2
	// Indicates that the span describes a request to some remote service.
	Span_SPAN_KIND_CLIENT Span_SpanKind = 3
	// 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_SPAN_KIND_PRODUCER Span_SpanKind = 4
	// 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.
	Span_SPAN_KIND_CONSUMER Span_SpanKind = 5
)

func (Span_SpanKind) Descriptor 

func (Span_SpanKind) Descriptor() protoreflect.EnumDescriptor

func (Span_SpanKind) Enum 

func (x Span_SpanKind) Enum() *Span_SpanKind

func (Span_SpanKind) EnumDescriptor deprecated 

func (Span_SpanKind) EnumDescriptor() ([]byte, []int)

Deprecated: Use Span_SpanKind.Descriptor instead.

func (Span_SpanKind) Number 

func (x Span_SpanKind) Number() protoreflect.EnumNumber

func (Span_SpanKind) String 

func (x Span_SpanKind) String() string

func (Span_SpanKind) Type 

func (Span_SpanKind) Type() protoreflect.EnumType

type Status 

type Status struct {

	// A developer-facing human readable error message.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// The status code.
	Code Status_StatusCode `protobuf:"varint,3,opt,name=code,proto3,enum=opentelemetry.proto.trace.v1.Status_StatusCode" json:"code,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Status) Descriptor deprecated 

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode 

func (x *Status) GetCode() Status_StatusCode

func (*Status) GetMessage 

func (x *Status) GetMessage() string

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

func (x *Status) String() string

type Status_StatusCode 

type Status_StatusCode int32

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

const (
	// The default status.
	Status_STATUS_CODE_UNSET Status_StatusCode = 0
	// The Span has been validated by an Application developers or Operator to have
	// completed successfully.
	Status_STATUS_CODE_OK Status_StatusCode = 1
	// The Span contains an error.
	Status_STATUS_CODE_ERROR Status_StatusCode = 2
)

func (Status_StatusCode) Descriptor 

func (Status_StatusCode) Descriptor() protoreflect.EnumDescriptor

func (Status_StatusCode) Enum 

func (x Status_StatusCode) Enum() *Status_StatusCode

func (Status_StatusCode) EnumDescriptor deprecated 

func (Status_StatusCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Status_StatusCode.Descriptor instead.

func (Status_StatusCode) Number 

func (x Status_StatusCode) Number() protoreflect.EnumNumber

func (Status_StatusCode) String 

func (x Status_StatusCode) String() string

func (Status_StatusCode) Type 

func (Status_StatusCode) Type() protoreflect.EnumType

type TracesData 

type TracesData struct {

	// 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.
	ResourceSpans []*ResourceSpans `protobuf:"bytes,1,rep,name=resource_spans,json=resourceSpans,proto3" json:"resource_spans,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*TracesData) Descriptor deprecated 

func (*TracesData) Descriptor() ([]byte, []int)

Deprecated: Use TracesData.ProtoReflect.Descriptor instead.

func (*TracesData) GetResourceSpans 

func (x *TracesData) GetResourceSpans() []*ResourceSpans

func (*TracesData) ProtoMessage 

func (*TracesData) ProtoMessage()

func (*TracesData) ProtoReflect 

func (x *TracesData) ProtoReflect() protoreflect.Message

func (*TracesData) Reset 

func (x *TracesData) Reset()

func (*TracesData) String 

func (x *TracesData) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.