trace

Documentation

Index

• Constants
• 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 string, hdr map[string]string, ...) (opentracing.Span, context.Context)
• func FinishHTTPSpan(sp opentracing.Span, code int)
• func HTTPOpName(method, path string) string
• func HTTPSpan(path string, r *http.Request) (opentracing.Span, *http.Request)
• func SQLSpan(ctx context.Context, opName, cmp, sqlType, instance, user, stmt string, ...) (opentracing.Span, context.Context)
• func Setup(name, ver, agent, typ string, prm float64) error
• func SpanError(sp opentracing.Span)
• func SpanSuccess(sp opentracing.Span)

Constants

const (
	// KafkaConsumerComponent definition.
	KafkaConsumerComponent = "kafka-consumer"
	// KafkaAsyncProducerComponent definition.
	KafkaAsyncProducerComponent = "kafka-async-producer"
	// AMQPConsumerComponent definition.
	AMQPConsumerComponent = "amqp-consumer"
	// AMQPPublisherComponent definition.
	AMQPPublisherComponent = "amqp-publisher"
	// HTTPComponent definition.
	HTTPComponent = "http"
	// HTTPClientComponent definition.
	HTTPClientComponent = "http-client"
)

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 string,
	hdr map[string]string,
	tags ...opentracing.Tag,
) (opentracing.Span, context.Context)

ConsumerSpan starts a new consumer span.

func FinishHTTPSpan

func FinishHTTPSpan(sp opentracing.Span, code int)

FinishHTTPSpan finishes a HTTP span by providing a HTTP status code.

func HTTPOpName

func HTTPOpName(method, path string) string

HTTPOpName return a string representation of the HTTP request operation.

func HTTPSpan

func HTTPSpan(path string, r *http.Request) (opentracing.Span, *http.Request)

HTTPSpan starts a new HTTP span.

func SQLSpan

func SQLSpan(
	ctx context.Context,
	opName, cmp, sqlType, instance, user, stmt string,
	tags ...opentracing.Tag,
) (opentracing.Span, context.Context)

SQLSpan starts a new SQL child span with specified tags.

func Setup

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

Setup tracing by providing all necessary parameters.

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.