trace

Documentation

Overview

Package trace provides trace support and helper methods.

Index

• Constants
• Variables
• func ChildSpan(ctx context.Context, opName, cmp string, tags ...opentracing.Tag) (opentracing.Span, context.Context)
• func Close() error
• func ComponentOpName(cmp, target string) string
• func ConsumerSpan(ctx context.Context, opName, cmp, corID string, hdr map[string]string, ...) (opentracing.Span, context.Context)
• func Setup(name, ver, agent, typ string, prm float64, buckets []float64) error
• func SpanComplete(sp opentracing.Span, err error)
• func SpanError(sp opentracing.Span)
• func SpanSuccess(sp opentracing.Span)

Constants

const (
	// HostsTag is used to tag the components's hosts.
	HostsTag = "hosts"
	// VersionTag is used to tag the components's version.
	VersionTag = "version"
)

Variables

var (

	// Version will be used to tag all traced components.
	// It can be used to distinguish between dev, stage, and prod environments.
	Version = "dev"
)

Functions

func ChildSpan

func ChildSpan(ctx context.Context, opName, cmp string, tags ...opentracing.Tag) (opentracing.Span, context.Context)

ChildSpan starts a new child span with specified tags.

func Close

func Close() error

Close the tracer.

func ComponentOpName

func ComponentOpName(cmp, target string) string

ComponentOpName returns a operation name for a component.

func ConsumerSpan

func ConsumerSpan(ctx context.Context, opName, cmp, corID string, hdr map[string]string,
	tags ...opentracing.Tag) (opentracing.Span, context.Context)

ConsumerSpan starts a new consumer span.

func Setup

func Setup(name, ver, agent, typ string, prm float64, buckets []float64) error

Setup tracing by providing all necessary parameters.

func SpanComplete

func SpanComplete(sp opentracing.Span, err error)

SpanComplete finishes a span with or without a error indicator.

func SpanError

func SpanError(sp opentracing.Span)

SpanError finishes a span with a error indicator.

func SpanSuccess

func SpanSuccess(sp opentracing.Span)

SpanSuccess finishes a span with a success indicator.