Documentation
¶
Overview ¶
Package tracing is a generated protocol buffer package.
It is generated from these files:
cockroach/util/tracing/span.proto
It has these top-level messages:
Span
Index ¶
- Constants
- Variables
- func AnnotateTrace()
- func DecodeRawSpan(enc []byte, dest *basictracer.RawSpan) error
- func Disable() func()
- func EncodeRawSpan(rawSpan *basictracer.RawSpan, dest []byte) ([]byte, error)
- func EnsureContext(ctx context.Context, tracer opentracing.Tracer) (context.Context, func())
- func FormatRawSpans(spans []basictracer.RawSpan) string
- func JoinOrNew(tr opentracing.Tracer, carrier *Span, opName string) (opentracing.Span, error)
- func JoinOrNewSnowball(opName string, carrier *Span, callback func(sp basictracer.RawSpan)) (opentracing.Span, error)
- func NewTracer() opentracing.Tracer
- type CallbackRecorder
- type Span
- func (*Span) Descriptor() ([]byte, []int)
- func (sp *Span) GetBaggage(fn func(key, value string))
- func (m *Span) Marshal() (data []byte, err error)
- func (m *Span) MarshalTo(data []byte) (int, error)
- func (*Span) ProtoMessage()
- func (m *Span) Reset()
- func (sp *Span) SetBaggageItem(key, value string)
- func (sp *Span) SetState(traceID, spanID uint64, sampled bool)
- func (m *Span) Size() (n int)
- func (sp *Span) State() (traceID, spanID uint64, sampled bool)
- func (m *Span) String() string
- func (m *Span) Unmarshal(data []byte) error
Constants ¶
const Snowball = "sb"
Snowball is set as Baggage on traces which are used for snowball tracing.
Variables ¶
var ( ErrInvalidLengthSpan = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowSpan = fmt.Errorf("proto: integer overflow") )
Functions ¶
func AnnotateTrace ¶
func AnnotateTrace()
AnnotateTrace adds an annotation to the golang executation tracer by calling a no-op cgo function.
func DecodeRawSpan ¶
func DecodeRawSpan(enc []byte, dest *basictracer.RawSpan) error
DecodeRawSpan unmarshals into the given RawSpan.
func Disable ¶
func Disable() func()
Disable is for benchmarking use and causes all future tracers to deal in no-ops. Calling the returned closure undoes this effect. There is no synchronization, so no moving parts are allowed while Disable and the closure are called.
func EncodeRawSpan ¶
func EncodeRawSpan(rawSpan *basictracer.RawSpan, dest []byte) ([]byte, error)
EncodeRawSpan encodes a raw span into bytes, using the given dest slice as a buffer.
func EnsureContext ¶
EnsureContext checks whether the given context.Context contains a Span. If not, it creates one using the provided Tracer and wraps it in the returned Span. The returned closure must be called after the request has been fully processed.
func FormatRawSpans ¶
func FormatRawSpans(spans []basictracer.RawSpan) string
FormatRawSpans formats the given spans for human consumption, showing the relationship using nesting and times as both relative to the previous event and cumulative.
func JoinOrNew ¶
func JoinOrNew(tr opentracing.Tracer, carrier *Span, opName string) (opentracing.Span, error)
JoinOrNew creates a new Span joined to the provided DelegatingCarrier or creates Span from the given tracer.
func JoinOrNewSnowball ¶
func JoinOrNewSnowball(opName string, carrier *Span, callback func(sp basictracer.RawSpan)) (opentracing.Span, error)
JoinOrNewSnowball returns a Span which records directly via the specified callback. If the given DelegatingCarrier is nil, a new Span is created. otherwise, the created Span is a child.
func NewTracer ¶
func NewTracer() opentracing.Tracer
NewTracer creates a Tracer which records to the net/trace endpoint.
Types ¶
type CallbackRecorder ¶
type CallbackRecorder func(sp basictracer.RawSpan)
A CallbackRecorder immediately invokes itself on received trace spans.
func (CallbackRecorder) RecordSpan ¶
func (cr CallbackRecorder) RecordSpan(sp basictracer.RawSpan)
RecordSpan implements basictracer.SpanRecorder.
type Span ¶
type Span struct {
TraceID uint64 `protobuf:"varint,1,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
SpanID uint64 `protobuf:"varint,2,opt,name=span_id,json=spanId,proto3" json:"span_id,omitempty"`
Sampled bool `protobuf:"varint,3,opt,name=sampled,proto3" json:"sampled,omitempty"`
Baggage map[string]string `` /* 148-byte string literal not displayed */
}
A Span message holds metadata of a (potentially ongoing) span of a distributed trace as per the OpenTracing specification. See http://opentracing.io/spec/ for details.
func (*Span) Descriptor ¶
func (*Span) GetBaggage ¶
GetBaggage implements basictracer.DelegatingCarrier.
func (*Span) ProtoMessage ¶
func (*Span) ProtoMessage()
func (*Span) SetBaggageItem ¶
SetBaggageItem implements basictracer.DelegatingCarrier.
Source Files