trace

Documentation

Index

• Constants
• func CreateTraceTagsFromMessageHeader(headers map[string][]string) map[string]string
• func FinishSpan(span *opentracing.Span)
• func ReadTraceHeaders(header *http.Header) *opentracing.SpanContext
• func SetSpanTags(span *opentracing.Span, tags *map[string]string)
• func StartSpan(spanContext *opentracing.SpanContext, operationName *string, ...) *opentracing.Span
• func TagSpanAsError(span *opentracing.Span, errorMessage, errorStack string)
• func WriteSpan(span *opentracing.Span) *api.TraceContext
• type OpenTracer
  • func (zk *OpenTracer) IsStarted() bool
  • func (zk *OpenTracer) Options() *Options
  • func (zk *OpenTracer) Start()
  • func (zk *OpenTracer) Stop()
• type Options
  • func GetDefaultTraceOptions() *Options
• type Tracer
  • func StartNewTracer(opts *Options) Tracer

Constants

const (
	// HeaderSourceID header
	HeaderSourceID = "ce-source"
	// HeaderEventType header
	HeaderEventType = "ce-type"
	// HeaderEventTypeVersion header
	HeaderEventTypeVersion = "ce-eventtypeversion"
	// HeaderEventID header
	HeaderEventID = "ce-id"
	// HeaderEventTime header
	HeaderEventTime = "ce-time"
	// HeaderSpecVersion header
	HeaderSpecVersion = "ce-specversion"
)

const (
	// DefaultTraceDebug trace option
	DefaultTraceDebug = false
	// DefaultTraceAPIURL trace option
	DefaultTraceAPIURL = "http://localhost:9411/api/v1/spans"
	// DefaultTraceHostPort trace option
	DefaultTraceHostPort = "0.0.0.0:0"
	// DefaultTraceServiceName trace option
	DefaultTraceServiceName = "trace-service"
	// DefaultTraceOperationName trace option
	DefaultTraceOperationName = "trace-operation"
)

const SpecVersion = "0.3"

SpecVersion CE header value

Functions

func CreateTraceTagsFromMessageHeader

func CreateTraceTagsFromMessageHeader(headers map[string][]string) map[string]string

CreateTraceTagsFromMessageHeader returns a map of trace headers.

func FinishSpan

func FinishSpan(span *opentracing.Span)

FinishSpan finishes the opentracing.Span.

func ReadTraceHeaders

func ReadTraceHeaders(header *http.Header) *opentracing.SpanContext

ReadTraceHeaders returns an opentracing.SpanContext instance.

func SetSpanTags

func SetSpanTags(span *opentracing.Span, tags *map[string]string)

SetSpanTags sets the opentracing.Span tags.

func StartSpan

func StartSpan(spanContext *opentracing.SpanContext, operationName *string, opts ...opentracing.StartSpanOption) *opentracing.Span

StartSpan starts and returns an opentracing.Span instance.

func TagSpanAsError

func TagSpanAsError(span *opentracing.Span, errorMessage, errorStack string)

TagSpanAsError tags the opentracing.Span as an error with the error details.

func WriteSpan

func WriteSpan(span *opentracing.Span) *api.TraceContext

WriteSpan writes the given opentracing.Span and returns an api.TraceContext instance.

Types

type OpenTracer

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

OpenTracer represents an open tracer.

func (*OpenTracer) IsStarted

func (zk *OpenTracer) IsStarted() bool

IsStarted returns a boolean value indicating id the OpenTracer is started or not.

func (*OpenTracer) Options

func (zk *OpenTracer) Options() *Options

Options returns the OpenTracer options.

func (*OpenTracer) Start

func (zk *OpenTracer) Start()

Start starts a new OpenTracer instance.

func (*OpenTracer) Stop

func (zk *OpenTracer) Stop()

Stop stops the OpenTracer.

type Options

type Options struct {
	Debug         bool
	APIURL        string
	HostPort      string
	ServiceName   string
	OperationName string
}

Options represents the trace options.

func GetDefaultTraceOptions

func GetDefaultTraceOptions() *Options

GetDefaultTraceOptions returns a default trace options instance.

type Tracer

type Tracer interface {
	IsStarted() bool
	Options() *Options
	Stop()
}

Tracer encapsulates the trace behaviours.

func StartNewTracer

func StartNewTracer(opts *Options) Tracer

StartNewTracer starts a new tracer.