ptrace

Documentation

Index

• Constants
• Variables
• type Marshaler
  • func NewJSONMarshaler() Marshaler
  • func NewProtoMarshaler() Marshaler
• type ResourceSpans
• type ResourceSpansSlice
• type ScopeSpans
• type ScopeSpansSlice
• type Sizer
• type Span
• type SpanEvent
• type SpanEventSlice
• type SpanKind
• type SpanLink
• type SpanLinkSlice
• type SpanSlice
• type SpanStatus
• type StatusCode
• type TraceState
• type Traces
• type Unmarshaler
  • func NewJSONUnmarshaler() Unmarshaler
  • func NewProtoUnmarshaler() Unmarshaler

Constants

const (
	// SpanKindUnspecified represents that the SpanKind is unspecified, it MUST NOT be used.
	SpanKindUnspecified = internal.SpanKindUnspecified

	// SpanKindInternal indicates that the span represents an internal operation within an application,
	// as opposed to an operation happening at the boundaries. Default value.
	SpanKindInternal = internal.SpanKindInternal

	// SpanKindServer indicates that the span covers server-side handling of an RPC or other
	// remote network request.
	SpanKindServer = internal.SpanKindServer

	// SpanKindProducer 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.
	SpanKindClient = internal.SpanKindClient

	// SpanKindProducer 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 = internal.SpanKindProducer

	// SpanKindConsumer 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 = internal.SpanKindConsumer
)

const (
	StatusCodeUnset = internal.StatusCodeUnset
	StatusCodeOk    = internal.StatusCodeOk
	StatusCodeError = internal.StatusCodeError
)

const (
	// TraceStateEmpty represents the empty TraceState.
	TraceStateEmpty = internal.TraceStateEmpty
)

Variables

var NewResourceSpans = internal.NewResourceSpans

NewResourceSpans is an alias for a function to create a new empty ResourceSpans.

var NewResourceSpansSlice = internal.NewResourceSpansSlice

NewResourceSpansSlice creates a ResourceSpansSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

var NewScopeSpans = internal.NewScopeSpans

NewScopeSpans is an alias for a function to create a new empty ScopeSpans.

var NewScopeSpansSlice = internal.NewScopeSpansSlice

NewScopeSpansSlice creates a ScopeSpansSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

var NewSpan = internal.NewSpan

NewSpan is an alias for a function to create a new empty Span.

var NewSpanEvent = internal.NewSpanEvent

NewSpanEvent is an alias for a function to create a new empty SpanEvent.

var NewSpanEventSlice = internal.NewSpanEventSlice

NewSpanEventSlice creates a SpanEventSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

var NewSpanLink = internal.NewSpanLink

NewSpanLink is an alias for a function to create a new empty SpanLink.

var NewSpanLinkSlice = internal.NewSpanLinkSlice

NewSpanLinkSlice creates a SpanLinkSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

var NewSpanSlice = internal.NewSpanSlice

NewSpanSlice creates a SpanSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

var NewSpanStatus = internal.NewSpanStatus

NewSpanStatus is an alias for a function to create a new empty SpanStatus.

var NewTraces = internal.NewTraces

NewTraces creates a new Traces struct.

Types

type Marshaler

type Marshaler interface {
	// MarshalTraces the given pdata.Traces into bytes.
	// If the error is not nil, the returned bytes slice cannot be used.
	MarshalTraces(td Traces) ([]byte, error)
}

Marshaler marshals pdata.Traces into bytes.

func NewJSONMarshaler

func NewJSONMarshaler() Marshaler

NewJSONMarshaler returns a model.Marshaler. Marshals to OTLP json bytes.

func NewProtoMarshaler

func NewProtoMarshaler() Marshaler

NewProtoMarshaler returns a Marshaler. Marshals to OTLP binary protobuf bytes.

type ResourceSpans

type ResourceSpans = internal.ResourceSpans

ResourceSpans is a collection of spans from a Resource.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewResourceSpans function to create new instances. Important: zero-initialized instance is not valid for use.

type ResourceSpansSlice

type ResourceSpansSlice = internal.ResourceSpansSlice

ResourceSpansSlice logically represents a slice of ResourceSpans.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewResourceSpansSlice function to create new instances. Important: zero-initialized instance is not valid for use.

type ScopeSpans

type ScopeSpans = internal.ScopeSpans

ScopeSpans is a collection of spans from a LibraryInstrumentation.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewScopeSpans function to create new instances. Important: zero-initialized instance is not valid for use.

type ScopeSpansSlice

type ScopeSpansSlice = internal.ScopeSpansSlice

ScopeSpansSlice logically represents a slice of ScopeSpans.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewScopeSpansSlice function to create new instances. Important: zero-initialized instance is not valid for use.

type Sizer

type Sizer interface {
	// TracesSize returns the size in bytes of a marshaled Traces.
	TracesSize(td Traces) int
}

Sizer is an optional interface implemented by the Marshaler, that calculates the size of a marshaled Traces.

type Span

type Span = internal.Span

Span represents a single operation within a trace. See Span definition in OTLP: https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSpan function to create new instances. Important: zero-initialized instance is not valid for use.

type SpanEvent

type SpanEvent = internal.SpanEvent

SpanEvent is a time-stamped annotation of the span, consisting of user-supplied text description and key-value pairs. See OTLP for event definition.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSpanEvent function to create new instances. Important: zero-initialized instance is not valid for use.

type SpanEventSlice

type SpanEventSlice = internal.SpanEventSlice

SpanEventSlice logically represents a slice of SpanEvent.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewSpanEventSlice function to create new instances. Important: zero-initialized instance is not valid for use.

type SpanKind

type SpanKind = internal.SpanKind

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

type SpanLink

type SpanLink = internal.SpanLink

SpanLink is a pointer from the current span to another span in the same trace or in a different trace. See Link definition in OTLP: https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSpanLink function to create new instances. Important: zero-initialized instance is not valid for use.

type SpanLinkSlice

type SpanLinkSlice = internal.SpanLinkSlice

SpanLinkSlice logically represents a slice of SpanLink.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewSpanLinkSlice function to create new instances. Important: zero-initialized instance is not valid for use.

type SpanSlice

type SpanSlice = internal.SpanSlice

SpanSlice logically represents a slice of Span.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewSpanSlice function to create new instances. Important: zero-initialized instance is not valid for use.

type SpanStatus

type SpanStatus = internal.SpanStatus

SpanStatus is an optional final status for this span. Semantically, when Status was not set, that means the span ended without errors and to assume Status.Ok (code = 0).

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSpanStatus function to create new instances. Important: zero-initialized instance is not valid for use.

type StatusCode

type StatusCode = internal.StatusCode

StatusCode mirrors the codes defined at https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status

type TraceState

type TraceState = internal.TraceState

TraceState is a string representing the tracestate in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header

type Traces

type Traces = internal.Traces

Traces is the top-level struct that is propagated through the traces pipeline. Use NewTraces to create new instance, zero-initialized instance is not valid for use.

type Unmarshaler

type Unmarshaler interface {
	// UnmarshalTraces the given bytes into pdata.Traces.
	// If the error is not nil, the returned pdata.Traces cannot be used.
	UnmarshalTraces(buf []byte) (Traces, error)
}

Unmarshaler unmarshalls bytes into pdata.Traces.

func NewJSONUnmarshaler

func NewJSONUnmarshaler() Unmarshaler

NewJSONUnmarshaler returns a model.Unmarshaler. Unmarshals from OTLP json bytes.

func NewProtoUnmarshaler

func NewProtoUnmarshaler() Unmarshaler

NewProtoUnmarshaler returns a model.Unmarshaler. Unmarshals from OTLP binary protobuf bytes.