otel

Documentation

Index

• func MarshallContext(ctx context.Context) ([]byte, error)
• func UnmarshallContext(ctx context.Context, obj []byte) (context.Context, error)
• type GlobalTracer
  • func New(opt *Options) (*GlobalTracer, error)
  • func (gt *GlobalTracer) StartSpan(ctx context.Context, name string, fn Operation, opts ...trace.SpanStartOption) (err error)
• type Operation
• type Options

Functions

func MarshallContext

func MarshallContext(ctx context.Context) ([]byte, error)

MarshallContext encodes the context to a JSON object. Assumes that there is an initialized context map propagator.

func UnmarshallContext

func UnmarshallContext(
	ctx context.Context,
	obj []byte,
) (context.Context, error)

UnmarshallContext decodes the JSON object into the given context. Assumes that there is an initialized context map propagator.

Types

type GlobalTracer

type GlobalTracer struct {
	trace.Tracer
}

func New

func New(opt *Options) (*GlobalTracer, error)

New connects to the collector and returns a new tracer.

func (*GlobalTracer) StartSpan

func (gt *GlobalTracer) StartSpan(
	ctx context.Context,
	name string,
	fn Operation,
	opts ...trace.SpanStartOption,
) (err error)

StartSpan creates a span arround a given operation. The function automatically closes the span, records the Operation error and returns it. Span.End does nothing if called more than one time.

type Operation

type Operation func(ctx context.Context, span trace.Span) error

Operation represents the execution wrapped by a span. The ctx parameter contains the context tied to the span. The returned error will be recorded in span and re-returned by StartSpan.

type Options

type Options struct {
	ServiceName string
	TracerName  string

	// CollectorAddr contains the grpc collector
	// address in the form <ip/domain>:<port>.
	CollectorAddr string

	// DialDeadline is the max time to dial
	// a connection with the collector.
	DialDeadline time.Duration
}

Options contains all basic elements to establish a connection with an OpenTelemetry cluster.