telemetry

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package telemetry provides a lightweight representations of OpenTelemetry telemetry that is compatible with the OTLP JSON protobuf encoding.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Attr 

type Attr struct {
	Key   string `json:"key,omitempty"`
	Value Value  `json:"value,omitempty"`
}

Attr is a key-value pair.

func Bool 

func Bool(key string, value bool) Attr

Bool returns an Attr for a bool value.

func Bytes 

func Bytes(key string, value []byte) Attr

Bytes returns an Attr for a []byte value. The passed slice must not be changed after it is passed.

func Float64 

func Float64(key string, value float64) Attr

Float64 returns an Attr for a float64 value.

func Int 

func Int(key string, value int) Attr

Int returns an Attr for an int value.

func Int64 

func Int64(key string, value int64) Attr

Int64 returns an Attr for an int64 value.

func Map 

func Map(key string, value ...Attr) Attr

Map returns an Attr for a map value. The passed slice must not be changed after it is passed.

func Slice 

func Slice(key string, value ...Value) Attr

Slice returns an Attr for a []Value value. The passed slice must not be changed after it is passed.

func String 

func String(key, value string) Attr

String returns an Attr for a string value.

func (Attr) Equal 

func (a Attr) Equal(b Attr) bool

Equal returns if a is equal to b.

type Resource 

type Resource struct {
	// Attrs are the set of attributes that describe the resource. Attribute
	// keys MUST be unique (it is not allowed to have more than one attribute
	// with the same key).
	Attrs []Attr `json:"attributes,omitempty"`
	// DroppedAttrs is the number of dropped attributes. If the value
	// is 0, then no attributes were dropped.
	DroppedAttrs uint32 `json:"droppedAttributesCount,omitempty"`
}

Resource information.

func (*Resource) UnmarshalJSON 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into r.

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 Resource `json:"resource"`
	// A list of ScopeSpans that originate from a resource.
	ScopeSpans []*ScopeSpans `json:"scopeSpans,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 `json:"schemaUrl,omitempty"`
}

A collection of ScopeSpans from a Resource.

func (*ResourceSpans) UnmarshalJSON 

func (rs *ResourceSpans) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into rs.

type Scope 

type Scope struct {
	Name         string `json:"name,omitempty"`
	Version      string `json:"version,omitempty"`
	Attrs        []Attr `json:"attributes,omitempty"`
	DroppedAttrs uint32 `json:"droppedAttributesCount,omitempty"`
}

Scope is the identifying values of the instrumentation scope.

func (*Scope) UnmarshalJSON 

func (s *Scope) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into r.

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 *Scope `json:"scope"`
	// A list of Spans that originate from an instrumentation scope.
	Spans []*Span `json:"spans,omitempty"`
	// The Schema URL, if known. This is the identifier of the Schema that the span data
	// is recorded in. 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.
	SchemaURL string `json:"schemaUrl,omitempty"`
}

A collection of Spans produced by an InstrumentationScope.

func (*ScopeSpans) UnmarshalJSON 

func (ss *ScopeSpans) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into ss.

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 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.
	TraceID TraceID `json:"traceId,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 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.
	SpanID SpanID `json:"spanId,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 `json:"traceState,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 SpanID `json:"parentSpanId,omitempty"`
	// 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].
	Flags uint32 `json:"flags,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 `json:"name"`
	// 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 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.
	StartTime time.Time `json:"startTimeUnixNano,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.
	EndTime time.Time `json:"endTimeUnixNano,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
	//     "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).
	Attrs []Attr `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.
	DroppedAttrs uint32 `json:"droppedAttributesCount,omitempty"`
	// events is a collection of Event items.
	Events []*SpanEvent `json:"events,omitempty"`
	// dropped_events_count is the number of dropped events. If the value is 0, then no
	// events were dropped.
	DroppedEvents uint32 `json:"droppedEventsCount,omitempty"`
	// links is a collection of Links, which are references from this span to a span
	// in the same or different trace.
	Links []*SpanLink `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.
	DroppedLinks uint32 `json:"droppedLinksCount,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 `json:"status,omitempty"`
}

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

func (Span) MarshalJSON 

func (s Span) MarshalJSON() ([]byte, error)

MarshalJSON encodes s into OTLP formatted JSON.

func (*Span) UnmarshalJSON 

func (s *Span) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into s.

type SpanEvent 

type SpanEvent struct {
	// time_unix_nano is the time the event occurred.
	Time time.Time `json:"timeUnixNano,omitempty"`
	// name of the event.
	// This field is semantically required to be set to non-empty string.
	Name string `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).
	Attrs []Attr `json:"attributes,omitempty"`
	// dropped_attributes_count is the number of dropped attributes. If the value is 0,
	// then no attributes were dropped.
	DroppedAttrs uint32 `json:"droppedAttributesCount,omitempty"`
}

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

func (SpanEvent) MarshalJSON 

func (e SpanEvent) MarshalJSON() ([]byte, error)

MarshalJSON encodes e into OTLP formatted JSON.

func (*SpanEvent) UnmarshalJSON 

func (se *SpanEvent) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into se.

type SpanFlags 

type SpanFlags int32

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. 

const (
	// Bits 0-7 are used for trace flags.
	SpanFlagsTraceFlagsMask SpanFlags = 255
	// 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.
	SpanFlagsContextHasIsRemoteMask SpanFlags = 256
	// SpanFlagsContextHasIsRemoteMask indicates the Span is remote.
	SpanFlagsContextIsRemoteMask SpanFlags = 512
)

type SpanID 

type SpanID [spanIDSize]byte

SpanID is a custom data type that is used for all span IDs.

func (SpanID) IsEmpty 

func (sid SpanID) IsEmpty() bool

IsEmpty returns true if the span ID contains at least one non-zero byte.

func (SpanID) MarshalJSON 

func (sid SpanID) MarshalJSON() ([]byte, error)

MarshalJSON converts span ID into a hex string enclosed in quotes.

func (SpanID) String 

func (sid SpanID) String() string

String returns the hex string representation form of a SpanID.

func (*SpanID) UnmarshalJSON 

func (sid *SpanID) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes span ID from hex string, possibly enclosed in quotes.

type SpanKind 

type 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 (
	// Indicates that the span represents an internal operation within an application,
	// as opposed to an operation happening at the boundaries. Default value.
	SpanKindInternal SpanKind = 1
	// Indicates that the span covers server-side handling of an RPC or other
	// remote network request.
	SpanKindServer SpanKind = 2
	// Indicates that the span describes a request to some remote service.
	SpanKindClient 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.
	SpanKindProducer 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.
	SpanKindConsumer SpanKind = 5
)
type SpanLink struct {
	// A unique identifier of a trace that this linked span is part of. The ID is a
	// 16-byte array.
	TraceID TraceID `json:"traceId,omitempty"`
	// A unique identifier for the linked span. The ID is an 8-byte array.
	SpanID SpanID `json:"spanId,omitempty"`
	// The trace_state associated with the link.
	TraceState string `json:"traceState,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).
	Attrs []Attr `json:"attributes,omitempty"`
	// dropped_attributes_count is the number of dropped attributes. If the value is 0,
	// then no attributes were dropped.
	DroppedAttrs uint32 `json:"droppedAttributesCount,omitempty"`
	// 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 the link 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 link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
	//
	// Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
	// When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.
	//
	// [Optional].
	Flags uint32 `json:"flags,omitempty"`
}

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 (*SpanLink) UnmarshalJSON 

func (sl *SpanLink) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into sl.

type Status 

type Status struct {
	// A developer-facing human readable error message.
	Message string `json:"message,omitempty"`
	// The status code.
	Code StatusCode `json:"code,omitempty"`
}

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

type StatusCode 

type 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.
	StatusCodeUnset StatusCode = 0
	// The Span has been validated by an Application developer or Operator to
	// have completed successfully.
	StatusCodeOK StatusCode = 1
	// The Span contains an error.
	StatusCodeError StatusCode = 2
)

func (StatusCode) String 

func (s StatusCode) String() string

type TraceID 

type TraceID [traceIDSize]byte

TraceID is a custom data type that is used for all trace IDs.

func (TraceID) IsEmpty 

func (tid TraceID) IsEmpty() bool

IsEmpty returns false if id contains at least one non-zero byte.

func (TraceID) MarshalJSON 

func (tid TraceID) MarshalJSON() ([]byte, error)

MarshalJSON converts the trace ID into a hex string enclosed in quotes.

func (TraceID) String 

func (tid TraceID) String() string

String returns the hex string representation form of a TraceID.

func (*TraceID) UnmarshalJSON 

func (tid *TraceID) UnmarshalJSON(data []byte) error

UnmarshalJSON inflates the trace ID from hex string, possibly enclosed in quotes.

type Traces 

type Traces 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 `json:"resourceSpans,omitempty"`
}

Traces 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 (*Traces) UnmarshalJSON 

func (td *Traces) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into td.

type Value 

type Value struct {
	// contains filtered or unexported fields
}

A Value represents a structured value. A zero value is valid and represents an empty value.

func BoolValue 

func BoolValue(v bool) Value

BoolValue returns a Value for a bool.

func BytesValue 

func BytesValue(v []byte) Value

BytesValue returns a Value for a byte slice. The passed slice must not be changed after it is passed.

func Float64Value 

func Float64Value(v float64) Value

Float64Value returns a Value for a float64.

func Int64Value 

func Int64Value(v int64) Value

Int64Value returns a Value for an int64.

func IntValue 

func IntValue(v int) Value

IntValue returns a Value for an int.

func MapValue 

func MapValue(kvs ...Attr) Value

MapValue returns a new Value for a slice of key-value pairs. The passed slice must not be changed after it is passed.

func SliceValue 

func SliceValue(vs ...Value) Value

SliceValue returns a Value for a slice of Value. The passed slice must not be changed after it is passed.

func StringValue 

func StringValue(v string) Value

StringValue returns a new Value for a string.

func (Value) AsBool 

func (v Value) AsBool() bool

AsBool returns the value held by v as a bool.

func (Value) AsBytes 

func (v Value) AsBytes() []byte

AsBytes returns the value held by v as a []byte.

func (Value) AsFloat64 

func (v Value) AsFloat64() float64

AsFloat64 returns the value held by v as a float64.

func (Value) AsInt64 

func (v Value) AsInt64() int64

AsInt64 returns the value held by v as an int64.

func (Value) AsMap 

func (v Value) AsMap() []Attr

AsMap returns the value held by v as a []Attr.

func (Value) AsSlice 

func (v Value) AsSlice() []Value

AsSlice returns the value held by v as a []Value.

func (Value) AsString 

func (v Value) AsString() string

AsString returns the value held by v as a string.

func (Value) Empty 

func (v Value) Empty() bool

Empty returns if v does not hold any value.

func (Value) Equal 

func (v Value) Equal(w Value) bool

Equal returns if v is equal to w.

func (Value) Kind 

func (v Value) Kind() ValueKind

Kind returns the Kind of v.

func (*Value) MarshalJSON 

func (v *Value) MarshalJSON() ([]byte, error)

MarshalJSON encodes v into OTLP formatted JSON.

func (Value) String 

func (v Value) String() string

String returns Value's value as a string, formatted like fmt.Sprint.

The returned string is meant for debugging; the string representation is not stable.

func (*Value) UnmarshalJSON 

func (v *Value) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the OTLP formatted JSON contained in data into v.

type ValueKind 

type ValueKind int

ValueKind is the kind of a Value. 

const (
	ValueKindEmpty ValueKind = iota
	ValueKindBool
	ValueKindFloat64
	ValueKindInt64
	ValueKindString
	ValueKindBytes
	ValueKindSlice
	ValueKindMap
)

ValueKind values.

func (ValueKind) String 

func (k ValueKind) String() string

Source Files

View all Source files

Directories

Path Synopsis
test module

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.