tracing

Documentation

Index

• func Attribute(k string, v interface{}) attribute.KeyValue
• func HTTPStatusCodeAttributes(code int) []attribute.KeyValue
• func Name(names ...string) string
• type LogrusHook
  • func NewLogrusHook() *LogrusHook
  • func (h *LogrusHook) Fire(entry *logrus.Entry) error
  • func (h *LogrusHook) Levels() []logrus.Level
• type Span
  • func SpanFromContext(ctx context.Context) *Span
  • func StartSpan(ctx context.Context, opName string, opts ...SpanOpt) (context.Context, *Span)
  • func (s *Span) AddEvent(name string, options ...trace.EventOption)
  • func (s *Span) End()
  • func (s *Span) SetAttributes(kv ...attribute.KeyValue)
  • func (s *Span) SetStatus(err error)
• type SpanOpt
  • func WithHTTPRequest(request *http.Request) SpanOpt
• type StartConfig

Functions

func Attribute

func Attribute(k string, v interface{}) attribute.KeyValue

Attribute takes a key value pair and returns attribute.KeyValue type.

func HTTPStatusCodeAttributes

func HTTPStatusCodeAttributes(code int) []attribute.KeyValue

HTTPStatusCodeAttributes generates attributes of the HTTP namespace as specified by the OpenTelemetry specification for a span.

func Name

func Name(names ...string) string

Name sets the span name by joining a list of strings in dot separated format.

Types

type LogrusHook

type LogrusHook struct{}

LogrusHook is a logrus hook which adds logrus events to active spans. If the span is not recording or the span context is invalid, the hook is a no-op.

func NewLogrusHook

func NewLogrusHook() *LogrusHook

NewLogrusHook creates a new logrus hook

func (*LogrusHook) Fire

func (h *LogrusHook) Fire(entry *logrus.Entry) error

Fire is called when a log event occurs.

func (*LogrusHook) Levels

func (h *LogrusHook) Levels() []logrus.Level

Levels returns the logrus levels that this hook is interested in.

type Span

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

Span is wrapper around otel trace.Span. Span is the individual component of a trace. It represents a single named and timed operation of a workflow that is traced.

func SpanFromContext

func SpanFromContext(ctx context.Context) *Span

SpanFromContext returns the current Span from the context.

func StartSpan

func StartSpan(ctx context.Context, opName string, opts ...SpanOpt) (context.Context, *Span)

StartSpan starts child span in a context.

func (*Span) AddEvent

func (s *Span) AddEvent(name string, options ...trace.EventOption)

AddEvent adds an event with provided name and options.

func (*Span) End

func (s *Span) End()

End completes the span.

func (*Span) SetAttributes

func (s *Span) SetAttributes(kv ...attribute.KeyValue)

SetAttributes sets kv as attributes of the span.

func (*Span) SetStatus

func (s *Span) SetStatus(err error)

SetStatus sets the status of the current span. If an error is encountered, it records the error and sets span status to Error.

type SpanOpt

type SpanOpt func(config *StartConfig)

func WithHTTPRequest

func WithHTTPRequest(request *http.Request) SpanOpt

WithHTTPRequest marks span as a HTTP request operation from client to server. It'll append attributes from the HTTP request object and mark it with `SpanKindClient` type.

type StartConfig

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

StartConfig defines configuration for a new span object.