telemetry
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package telemetry provides a lightweight representations of OpenTelemetrytelemetry that is compatible with the OTLP JSON protobuf encoding.
Index¶
- type Attr
- func Bool(key string, value bool) Attr
- func Bytes(key string, value []byte) Attr
- func Float64(key string, value float64) Attr
- func Int(key string, value int) Attr
- func Int64(key string, value int64) Attr
- func Map(key string, value ...Attr) Attr
- func Slice(key string, value ...Value) Attr
- func String(key, value string) Attr
- type Resource
- type ResourceSpans
- type Scope
- type ScopeSpans
- type Span
- type SpanEvent
- type SpanFlags
- type SpanID
- type SpanKind
- type SpanLink
- type Status
- type StatusCode
- type TraceID
- type Traces
- type Value
- func (v Value) AsBool() bool
- func (v Value) AsBytes() []byte
- func (v Value) AsFloat64() float64
- func (v Value) AsInt64() int64
- func (v Value) AsMap() []Attr
- func (v Value) AsSlice() []Value
- func (v Value) AsString() string
- func (v Value) Empty() bool
- func (v Value) Equal(w Value) bool
- func (v Value) Kind() ValueKind
- func (v *Value) MarshalJSON() ([]byte, error)
- func (v Value) String() string
- func (v *Value) UnmarshalJSON(data []byte) error
- type ValueKind
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAttr¶
Attr is a key-value pair.
funcBytes¶
Bytes returns an Attr for a []byte value.The passed slice must not be changed after it is passed.
funcMap¶
Map returns an Attr for a map value.The passed slice must not be changed after it is passed.
typeResource¶
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.DroppedAttrsuint32 `json:"droppedAttributesCount,omitempty"`}Resource information.
func (*Resource)UnmarshalJSON¶
UnmarshalJSON decodes the OTLP formatted JSON contained in data into r.
typeResourceSpans¶
type ResourceSpans struct {// The resource for the spans in this message.// If this field is not set then no resource info is known.ResourceResource `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.SchemaURLstring `json:"schemaUrl,omitempty"`}ResourceSpans is 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.
typeScope¶
type Scope struct {Namestring `json:"name,omitempty"`Versionstring `json:"version,omitempty"`Attrs []Attr `json:"attributes,omitempty"`DroppedAttrsuint32 `json:"droppedAttributesCount,omitempty"`}Scope is the identifying values of the instrumentation scope.
func (*Scope)UnmarshalJSON¶
UnmarshalJSON decodes the OTLP formatted JSON contained in data into r.
typeScopeSpans¶
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.SchemaURLstring `json:"schemaUrl,omitempty"`}ScopeSpans is 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.
typeSpan¶
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.TraceIDTraceID `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.SpanIDSpanID `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 alsohttps://github.com/w3c/distributed-tracing for more details about this field.TraceStatestring `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.ParentSpanIDSpanID `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`.//// Seehttps://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].Flagsuint32 `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.Namestring `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.KindSpanKind `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.StartTimetime.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.EndTimetime.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.DroppedAttrsuint32 `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.DroppedEventsuint32 `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.DroppedLinksuint32 `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 thesystem.
func (Span)MarshalJSON¶
MarshalJSON encodes s into OTLP formatted JSON.
func (*Span)UnmarshalJSON¶
UnmarshalJSON decodes the OTLP formatted JSON contained in data into s.
typeSpanEvent¶
type SpanEvent struct {// time_unix_nano is the time the event occurred.Timetime.Time `json:"timeUnixNano,omitempty"`// name of the event.// This field is semantically required to be set to non-empty string.Namestring `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.DroppedAttrsuint32 `json:"droppedAttributesCount,omitempty"`}SpanEvent is a time-stamped annotation of the span, consisting ofuser-supplied text description and key-value pairs.
func (SpanEvent)MarshalJSON¶
MarshalJSON encodes e into OTLP formatted JSON.
func (*SpanEvent)UnmarshalJSON¶
UnmarshalJSON decodes the OTLP formatted JSON contained in data into se.
typeSpanFlags¶
type SpanFlagsint32
SpanFlags represents constants used to interpret theSpan.flags field, which is protobuf 'fixed32' type and is tobe used as bit-fields. Each non-zero value defined in this enum isa bit-mask. To extract the bit-field, for example, use anexpression like:
(span.flags & SPAN_FLAGS_TRACE_FLAGS_MASK)
Seehttps://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
Note that Span flags were introduced in version 1.1 of theOpenTelemetry protocol. Older Span producers do not set thisfield, consequently consumers should not rely on the absence of aparticular flag bit to indicate the presence of a particular feature.
const (// SpanFlagsTraceFlagsMask is a mask for trace-flags.//// Bits 0-7 are used for trace flags.SpanFlagsTraceFlagsMaskSpanFlags = 255// SpanFlagsContextHasIsRemoteMask is a mask for HAS_IS_REMOTE status.//// 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.SpanFlagsContextHasIsRemoteMaskSpanFlags = 256// SpanFlagsContextIsRemoteMask is a mask for IS_REMOTE status.//// Bits 8 and 9 are used to indicate that the parent span or link span is// remote. Bit 9 (`IS_REMOTE`) indicates whether the span or link is// remote.SpanFlagsContextIsRemoteMaskSpanFlags = 512)
typeSpanID¶
type SpanID [spanIDSize]byte
SpanID is a custom data type that is used for all span IDs.
func (SpanID)MarshalJSON¶
MarshalJSON converts span ID into a hex string enclosed in quotes.
func (*SpanID)UnmarshalJSON¶
UnmarshalJSON decodes span ID from hex string, possibly enclosed in quotes.
typeSpanKind¶
type SpanKindint32
SpanKind is the type of span. Can be used to specify additional relationships between spansin addition to a parent/child relationship.
const (// SpanKindInternal indicates that the span represents an internal// operation within an application, as opposed to an operation happening at// the boundaries.SpanKindInternalSpanKind = 1// SpanKindServer indicates that the span covers server-side handling of an// RPC or other remote network request.SpanKindServerSpanKind = 2// SpanKindClient indicates that the span describes a request to some// remote service.SpanKindClientSpanKind = 3// SpanKindProducer indicates that the span describes a producer sending a// message to a broker. Unlike SpanKindClient and SpanKindServer, there is// often no direct critical path latency relationship between producer and// consumer spans. A SpanKindProducer span ends when the message was// accepted by the broker while the logical processing of the message might// span a much longer time.SpanKindProducerSpanKind = 4// SpanKindConsumer indicates that the span describes a consumer receiving// a message from a broker. Like SpanKindProducer, there is often no direct// critical path latency relationship between producer and consumer spans.SpanKindConsumerSpanKind = 5)
typeSpanLink¶
type SpanLink struct {// A unique identifier of a trace that this linked span is part of. The ID is a// 16-byte array.TraceIDTraceID `json:"traceId,omitempty"`// A unique identifier for the linked span. The ID is an 8-byte array.SpanIDSpanID `json:"spanId,omitempty"`// The trace_state associated with the link.TraceStatestring `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.DroppedAttrsuint32 `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`.//// Seehttps://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].Flagsuint32 `json:"flags,omitempty"`}SpanLink is a reference from the current span to another span in the sametrace or in a different trace. For example, this can be used in batchingoperations, where a single batch handler processes multiple requests fromdifferent traces or when the handler receives a request from a differentproject.
func (*SpanLink)UnmarshalJSON¶
UnmarshalJSON decodes the OTLP formatted JSON contained in data into sl.
typeStatus¶
type Status struct {// A developer-facing human readable error message.Messagestring `json:"message,omitempty"`// The status code.CodeStatusCode `json:"code,omitempty"`}Status defines a logical error model that is suitable for differentprogramming environments, including REST APIs and RPC APIs.
typeStatusCode¶
type StatusCodeint32
StatusCode is the status of a Span.
For the semantics of status codes seehttps://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status
const (// StatusCodeUnset is the default status.StatusCodeUnsetStatusCode = 0// StatusCodeOK is used when the Span has been validated by an Application// developer or Operator to have completed successfully.StatusCodeOKStatusCode = 1// StatusCodeError is used when the Span contains an error.StatusCodeErrorStatusCode = 2)
func (StatusCode)String¶
func (sStatusCode) String()string
typeTraceID¶
type TraceID [traceIDSize]byte
TraceID is a custom data type that is used for all trace IDs.
func (TraceID)MarshalJSON¶
MarshalJSON converts the trace ID into a hex string enclosed in quotes.
func (*TraceID)UnmarshalJSON¶
UnmarshalJSON inflates the trace ID from hex string, possibly enclosed inquotes.
typeTraces¶
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 donot implement the OTLP protocol.
The main difference between this message and collector protocol is thatin this message there will not be any "control" or "metadata" specific toOTLP protocol.
When new fields are added into this message, the OTLP request MUST be updatedas well.
func (*Traces)UnmarshalJSON¶
UnmarshalJSON decodes the OTLP formatted JSON contained in data into td.
typeValue¶
type Value struct {// contains filtered or unexported fields}A Value represents a structured value.A zero value is valid and represents an empty value.
funcBytesValue¶
BytesValue returns aValue for a byte slice. The passed slice must not bechanged after it is passed.
funcMapValue¶
MapValue returns a newValue for a slice of key-value pairs. The passedslice must not be changed after it is passed.
funcSliceValue¶
SliceValue returns aValue for a slice ofValue. The passed slice mustnot be changed after it is passed.
func (*Value)MarshalJSON¶
MarshalJSON encodes v into OTLP formatted JSON.
func (Value)String¶
String returns Value's value as a string, formatted likefmt.Sprint.
The returned string is meant for debugging;the string representation is not stable.
func (*Value)UnmarshalJSON¶
UnmarshalJSON decodes the OTLP formatted JSON contained in data into v.