v1

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Jun 15, 2020 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Span_SpanKind_name = map[int32]string{
	0: "SPAN_KIND_UNSPECIFIED",
	1: "INTERNAL",
	2: "SERVER",
	3: "CLIENT",
	4: "PRODUCER",
	5: "CONSUMER",
}
View Source 
var Span_SpanKind_value = map[string]int32{
	"SPAN_KIND_UNSPECIFIED": 0,
	"INTERNAL":              1,
	"SERVER":                2,
	"CLIENT":                3,
	"PRODUCER":              4,
	"CONSUMER":              5,
}
View Source 
var Status_StatusCode_name = map[int32]string{
	0:  "Ok",
	1:  "Cancelled",
	2:  "UnknownError",
	3:  "InvalidArgument",
	4:  "DeadlineExceeded",
	5:  "NotFound",
	6:  "AlreadyExists",
	7:  "PermissionDenied",
	8:  "ResourceExhausted",
	9:  "FailedPrecondition",
	10: "Aborted",
	11: "OutOfRange",
	12: "Unimplemented",
	13: "InternalError",
	14: "Unavailable",
	15: "DataLoss",
	16: "Unauthenticated",
}
View Source 
var Status_StatusCode_value = map[string]int32{
	"Ok":                 0,
	"Cancelled":          1,
	"UnknownError":       2,
	"InvalidArgument":    3,
	"DeadlineExceeded":   4,
	"NotFound":           5,
	"AlreadyExists":      6,
	"PermissionDenied":   7,
	"ResourceExhausted":  8,
	"FailedPrecondition": 9,
	"Aborted":            10,
	"OutOfRange":         11,
	"Unimplemented":      12,
	"InternalError":      13,
	"Unavailable":        14,
	"DataLoss":           15,
	"Unauthenticated":    16,
}

Functions

This section is empty.

Types

type InstrumentationLibrarySpans 

type InstrumentationLibrarySpans struct {
	// The instrumentation library information for the spans in this message.
	// If this field is not set then no library info is known.
	InstrumentationLibrary *v11.InstrumentationLibrary `` /* 127-byte string literal not displayed */
	// A list of Spans that originate from an instrumentation library.
	Spans                []*Span  `protobuf:"bytes,2,rep,name=spans,proto3" json:"spans,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A collection of Spans produced by an InstrumentationLibrary.

func (*InstrumentationLibrarySpans) Descriptor 

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

func (*InstrumentationLibrarySpans) GetInstrumentationLibrary 

func (m *InstrumentationLibrarySpans) GetInstrumentationLibrary() *v11.InstrumentationLibrary

func (*InstrumentationLibrarySpans) GetSpans 

func (m *InstrumentationLibrarySpans) GetSpans() []*Span

func (*InstrumentationLibrarySpans) ProtoMessage 

func (*InstrumentationLibrarySpans) ProtoMessage()

func (*InstrumentationLibrarySpans) Reset 

func (m *InstrumentationLibrarySpans) Reset()

func (*InstrumentationLibrarySpans) String 

func (m *InstrumentationLibrarySpans) String() string

func (*InstrumentationLibrarySpans) XXX_DiscardUnknown 

func (m *InstrumentationLibrarySpans) XXX_DiscardUnknown()

func (*InstrumentationLibrarySpans) XXX_Marshal 

func (m *InstrumentationLibrarySpans) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstrumentationLibrarySpans) XXX_Merge 

func (m *InstrumentationLibrarySpans) XXX_Merge(src proto.Message)

func (*InstrumentationLibrarySpans) XXX_Size 

func (m *InstrumentationLibrarySpans) XXX_Size() int

func (*InstrumentationLibrarySpans) XXX_Unmarshal 

func (m *InstrumentationLibrarySpans) XXX_Unmarshal(b []byte) error

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 InstrumentationLibrarySpans that originate from a resource.
	InstrumentationLibrarySpans []*InstrumentationLibrarySpans `` /* 144-byte string literal not displayed */
	XXX_NoUnkeyedLiteral        struct{}                       `json:"-"`
	XXX_unrecognized            []byte                         `json:"-"`
	XXX_sizecache               int32                          `json:"-"`
}

A collection of InstrumentationLibrarySpans from a Resource.

func (*ResourceSpans) Descriptor 

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

func (*ResourceSpans) GetInstrumentationLibrarySpans 

func (m *ResourceSpans) GetInstrumentationLibrarySpans() []*InstrumentationLibrarySpans

func (*ResourceSpans) GetResource 

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

func (*ResourceSpans) ProtoMessage 

func (*ResourceSpans) ProtoMessage()

func (*ResourceSpans) Reset 

func (m *ResourceSpans) Reset()

func (*ResourceSpans) String 

func (m *ResourceSpans) String() string

func (*ResourceSpans) XXX_DiscardUnknown 

func (m *ResourceSpans) XXX_DiscardUnknown()

func (*ResourceSpans) XXX_Marshal 

func (m *ResourceSpans) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ResourceSpans) XXX_Merge 

func (m *ResourceSpans) XXX_Merge(src proto.Message)

func (*ResourceSpans) XXX_Size 

func (m *ResourceSpans) XXX_Size() int

func (*ResourceSpans) XXX_Unmarshal 

func (m *ResourceSpans) XXX_Unmarshal(b []byte) error

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.
	// When null or empty string received - receiver may use string "name"
	// as a replacement. There might be smarted algorithms implemented by
	// receiver to fix the empty 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. The value can be a string,
	// an integer, a double or the Boolean values `true` or `false`. 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
	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
	// wasn't set it is means span ended without errors and assume
	// Status.Ok (code = 0).
	Status               *Status  `protobuf:"bytes,15,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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.

func (*Span) Descriptor 

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

func (*Span) GetAttributes 

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

func (*Span) GetDroppedAttributesCount 

func (m *Span) GetDroppedAttributesCount() uint32

func (*Span) GetDroppedEventsCount 

func (m *Span) GetDroppedEventsCount() uint32

func (*Span) GetDroppedLinksCount 

func (m *Span) GetDroppedLinksCount() uint32

func (*Span) GetEndTimeUnixNano 

func (m *Span) GetEndTimeUnixNano() uint64

func (*Span) GetEvents 

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

func (*Span) GetKind 

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

func (*Span) GetName 

func (m *Span) GetName() string

func (*Span) GetParentSpanId 

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

func (*Span) GetSpanId 

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

func (*Span) GetStartTimeUnixNano 

func (m *Span) GetStartTimeUnixNano() uint64

func (*Span) GetStatus 

func (m *Span) GetStatus() *Status

func (*Span) GetTraceId 

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

func (*Span) GetTraceState 

func (m *Span) GetTraceState() string

func (*Span) ProtoMessage 

func (*Span) ProtoMessage()

func (*Span) Reset 

func (m *Span) Reset()

func (*Span) String 

func (m *Span) String() string

func (*Span) XXX_DiscardUnknown 

func (m *Span) XXX_DiscardUnknown()

func (*Span) XXX_Marshal 

func (m *Span) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Span) XXX_Merge 

func (m *Span) XXX_Merge(src proto.Message)

func (*Span) XXX_Size 

func (m *Span) XXX_Size() int

func (*Span) XXX_Unmarshal 

func (m *Span) XXX_Unmarshal(b []byte) error

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.
	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 */
	XXX_NoUnkeyedLiteral   struct{} `json:"-"`
	XXX_unrecognized       []byte   `json:"-"`
	XXX_sizecache          int32    `json:"-"`
}

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

func (*Span_Event) Descriptor 

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

func (*Span_Event) GetAttributes 

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

func (*Span_Event) GetDroppedAttributesCount 

func (m *Span_Event) GetDroppedAttributesCount() uint32

func (*Span_Event) GetName 

func (m *Span_Event) GetName() string

func (*Span_Event) GetTimeUnixNano 

func (m *Span_Event) GetTimeUnixNano() uint64

func (*Span_Event) ProtoMessage 

func (*Span_Event) ProtoMessage()

func (*Span_Event) Reset 

func (m *Span_Event) Reset()

func (*Span_Event) String 

func (m *Span_Event) String() string

func (*Span_Event) XXX_DiscardUnknown 

func (m *Span_Event) XXX_DiscardUnknown()

func (*Span_Event) XXX_Marshal 

func (m *Span_Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Span_Event) XXX_Merge 

func (m *Span_Event) XXX_Merge(src proto.Message)

func (*Span_Event) XXX_Size 

func (m *Span_Event) XXX_Size() int

func (*Span_Event) XXX_Unmarshal 

func (m *Span_Event) XXX_Unmarshal(b []byte) error
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.
	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 */
	XXX_NoUnkeyedLiteral   struct{} `json:"-"`
	XXX_unrecognized       []byte   `json:"-"`
	XXX_sizecache          int32    `json:"-"`
}

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 

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

func (*Span_Link) GetAttributes 

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

func (*Span_Link) GetDroppedAttributesCount 

func (m *Span_Link) GetDroppedAttributesCount() uint32

func (*Span_Link) GetSpanId 

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

func (*Span_Link) GetTraceId 

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

func (*Span_Link) GetTraceState 

func (m *Span_Link) GetTraceState() string

func (*Span_Link) ProtoMessage 

func (*Span_Link) ProtoMessage()

func (*Span_Link) Reset 

func (m *Span_Link) Reset()

func (*Span_Link) String 

func (m *Span_Link) String() string

func (*Span_Link) XXX_DiscardUnknown 

func (m *Span_Link) XXX_DiscardUnknown()

func (*Span_Link) XXX_Marshal 

func (m *Span_Link) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Span_Link) XXX_Merge 

func (m *Span_Link) XXX_Merge(src proto.Message)

func (*Span_Link) XXX_Size 

func (m *Span_Link) XXX_Size() int

func (*Span_Link) XXX_Unmarshal 

func (m *Span_Link) XXX_Unmarshal(b []byte) error

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 operations happening at the boundaries. Default value.
	Span_INTERNAL Span_SpanKind = 1
	// Indicates that the span covers server-side handling of an RPC or other
	// remote network request.
	Span_SERVER Span_SpanKind = 2
	// Indicates that the span describes a request to some remote service.
	Span_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_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_CONSUMER Span_SpanKind = 5
)

func (Span_SpanKind) EnumDescriptor 

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

func (Span_SpanKind) String 

func (x Span_SpanKind) String() string

type Status 

type Status struct {
	// The status code. This is optional field. It is safe to assume 0 (OK)
	// when not set.
	Code Status_StatusCode `protobuf:"varint,1,opt,name=code,proto3,enum=opentelemetry.proto.trace.v1.Status_StatusCode" json:"code,omitempty"`
	// A developer-facing human readable error message.
	Message              string   `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*Status) Descriptor 

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

func (*Status) GetCode 

func (m *Status) GetCode() Status_StatusCode

func (*Status) GetMessage 

func (m *Status) GetMessage() string

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) Reset 

func (m *Status) Reset()

func (*Status) String 

func (m *Status) String() string

func (*Status) XXX_DiscardUnknown 

func (m *Status) XXX_DiscardUnknown()

func (*Status) XXX_Marshal 

func (m *Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Status) XXX_Merge 

func (m *Status) XXX_Merge(src proto.Message)

func (*Status) XXX_Size 

func (m *Status) XXX_Size() int

func (*Status) XXX_Unmarshal 

func (m *Status) XXX_Unmarshal(b []byte) error

type Status_StatusCode 

type Status_StatusCode int32

StatusCode mirrors the codes defined at https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-tracing.md#statuscanonicalcode 

const (
	Status_Ok                 Status_StatusCode = 0
	Status_Cancelled          Status_StatusCode = 1
	Status_UnknownError       Status_StatusCode = 2
	Status_InvalidArgument    Status_StatusCode = 3
	Status_DeadlineExceeded   Status_StatusCode = 4
	Status_NotFound           Status_StatusCode = 5
	Status_AlreadyExists      Status_StatusCode = 6
	Status_PermissionDenied   Status_StatusCode = 7
	Status_ResourceExhausted  Status_StatusCode = 8
	Status_FailedPrecondition Status_StatusCode = 9
	Status_Aborted            Status_StatusCode = 10
	Status_OutOfRange         Status_StatusCode = 11
	Status_Unimplemented      Status_StatusCode = 12
	Status_InternalError      Status_StatusCode = 13
	Status_Unavailable        Status_StatusCode = 14
	Status_DataLoss           Status_StatusCode = 15
	Status_Unauthenticated    Status_StatusCode = 16
)

func (Status_StatusCode) EnumDescriptor 

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

func (Status_StatusCode) String 

func (x Status_StatusCode) 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.