trace

Documentation

Index

• type Event
• type SpanBatcher
• type SpanData
• type SpanSyncer

Types

type Event

type Event struct {
	// Name is the name of this event
	Name string

	// Attributes contains a list of kv pairs.
	Attributes []kv.KeyValue

	// Time is the time at which this event was recorded.
	Time time.Time
}

Event is used to describe an Event with a message string and set of Attributes.

type SpanBatcher

type SpanBatcher interface {
	ExportSpans(context.Context, []*SpanData)
}

SpanBatcher is a type for functions that receive batched of sampled trace spans.

The ExportSpans method is called asynchronously. However its should not take forever to process the spans.

The SpanData should not be modified.

type SpanData

type SpanData struct {
	SpanContext  apitrace.SpanContext
	ParentSpanID apitrace.SpanID
	SpanKind     apitrace.SpanKind
	Name         string
	StartTime    time.Time
	// The wall clock time of EndTime will be adjusted to always be offset
	// from StartTime by the duration of the span.
	EndTime                  time.Time
	Attributes               []kv.KeyValue
	MessageEvents            []Event
	Links                    []apitrace.Link
	StatusCode               codes.Code
	StatusMessage            string
	HasRemoteParent          bool
	DroppedAttributeCount    int
	DroppedMessageEventCount int
	DroppedLinkCount         int

	// ChildSpanCount holds the number of child span created for this span.
	ChildSpanCount int

	// Resource contains attributes representing an entity that produced this span.
	Resource *resource.Resource

	// InstrumentationLibrary defines the instrumentation library used to
	// providing instrumentation.
	InstrumentationLibrary instrumentation.Library
}

SpanData contains all the information collected by a span.

type SpanSyncer

type SpanSyncer interface {
	ExportSpan(context.Context, *SpanData)
}

SpanSyncer is a type for functions that receive a single sampled trace span.

The ExportSpan method is called synchronously. Therefore, it should not take forever to process the span.

The SpanData should not be modified.