tracing

Documentation

Index

• Constants
• Variables
• func Client(opts ...Option) middleware.Middleware
• func MustTracerProvider(url string, serviceName string, uuid string) *tracesdk.TracerProvider
• func Server(opts ...Option) middleware.Middleware
• func SpanID() log.Valuer
• func TraceID() log.Valuer
• func TracerProvider(url string, serviceName string, uuid string) (*tracesdk.TracerProvider, error)
• type ClientHandler
  • func (c *ClientHandler) HandleConn(ctx context.Context, cs stats.ConnStats)
  • func (c *ClientHandler) HandleRPC(ctx context.Context, rs stats.RPCStats)
  • func (c *ClientHandler) TagConn(ctx context.Context, cti *stats.ConnTagInfo) context.Context
  • func (c *ClientHandler) TagRPC(ctx context.Context, rti *stats.RPCTagInfo) context.Context
• type Conf
  • func (*Conf) Descriptor() ([]byte, []int)
  • func (x *Conf) GetEnable() bool
  • func (x *Conf) GetEndpoint() string
  • func (*Conf) ProtoMessage()
  • func (x *Conf) ProtoReflect() protoreflect.Message
  • func (x *Conf) Reset()
  • func (x *Conf) String() string
  • func (m *Conf) Validate() error
  • func (m *Conf) ValidateAll() error
• type ConfMultiError
  • func (m ConfMultiError) AllErrors() []error
  • func (m ConfMultiError) Error() string
• type ConfValidationError
  • func (e ConfValidationError) Cause() error
  • func (e ConfValidationError) Error() string
  • func (e ConfValidationError) ErrorName() string
  • func (e ConfValidationError) Field() string
  • func (e ConfValidationError) Key() bool
  • func (e ConfValidationError) Reason() string
• type Metadata
  • func (b Metadata) Extract(parent context.Context, carrier propagation.TextMapCarrier) context.Context
  • func (b Metadata) Fields() []string
  • func (b Metadata) Inject(ctx context.Context, carrier propagation.TextMapCarrier)
• type Option
  • func WithPropagator(propagator propagation.TextMapPropagator) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option
• type TraceContext
  • func (tc TraceContext) Extract(ctx context.Context, carrier propagation.TextMapCarrier) context.Context
  • func (tc TraceContext) Fields() []string
  • func (tc TraceContext) Inject(ctx context.Context, carrier propagation.TextMapCarrier)
• type Tracer
  • func NewTracer(kind trace.SpanKind, opts ...Option) *Tracer
  • func (t *Tracer) End(ctx context.Context, span trace.Span, m interface{}, err error)
  • func (t *Tracer) Start(ctx context.Context, operation string, carrier propagation.TextMapCarrier) (context.Context, trace.Span)

Constants

const Name = "jaeger"

Variables

var File_tracing_conf_proto protoreflect.FileDescriptor

Functions

func Client

func Client(opts ...Option) middleware.Middleware

Client returns a new client middleware for OpenTelemetry.

func MustTracerProvider

func MustTracerProvider(url string, serviceName string, uuid string) *tracesdk.TracerProvider

func Server

func Server(opts ...Option) middleware.Middleware

Server returns a new server middleware for OpenTelemetry.

func SpanID

func SpanID() log.Valuer

SpanID returns a spanid valuer.

func TraceID

func TraceID() log.Valuer

TraceID returns a traceid valuer.

func TracerProvider

func TracerProvider(url string, serviceName string, uuid string) (*tracesdk.TracerProvider, error)

TracerProvider Get trace provider

Types

type ClientHandler

type ClientHandler struct{}

ClientHandler is tracing ClientHandler

func (*ClientHandler) HandleConn

func (c *ClientHandler) HandleConn(ctx context.Context, cs stats.ConnStats)

HandleConn exists to satisfy gRPC stats.Handler.

func (*ClientHandler) HandleRPC

func (c *ClientHandler) HandleRPC(ctx context.Context, rs stats.RPCStats)

HandleRPC implements per-RPC tracing and stats instrumentation.

func (*ClientHandler) TagConn

func (c *ClientHandler) TagConn(ctx context.Context, cti *stats.ConnTagInfo) context.Context

TagConn exists to satisfy gRPC stats.Handler.

func (*ClientHandler) TagRPC

func (c *ClientHandler) TagRPC(ctx context.Context, rti *stats.RPCTagInfo) context.Context

TagRPC implements per-RPC context management.

type Conf

type Conf struct {
	Enable   bool   `protobuf:"varint,1,opt,name=enable,proto3" json:"enable,omitempty"`
	Endpoint string `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// contains filtered or unexported fields
}

func (*Conf) Descriptor

func (*Conf) Descriptor() ([]byte, []int)

Deprecated: Use Conf.ProtoReflect.Descriptor instead.

func (*Conf) GetEnable

func (x *Conf) GetEnable() bool

func (*Conf) GetEndpoint

func (x *Conf) GetEndpoint() string

func (*Conf) ProtoMessage

func (*Conf) ProtoMessage()

func (*Conf) ProtoReflect

func (x *Conf) ProtoReflect() protoreflect.Message

func (*Conf) Reset

func (x *Conf) Reset()

func (*Conf) String

func (x *Conf) String() string

func (*Conf) Validate

func (m *Conf) Validate() error

Validate checks the field values on Conf with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Conf) ValidateAll

func (m *Conf) ValidateAll() error

ValidateAll checks the field values on Conf with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ConfMultiError, or nil if none found.

type ConfMultiError

type ConfMultiError []error

ConfMultiError is an error wrapping multiple validation errors returned by Conf.ValidateAll() if the designated constraints aren't met.

func (ConfMultiError) AllErrors

func (m ConfMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ConfMultiError) Error

func (m ConfMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ConfValidationError

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

ConfValidationError is the validation error returned by Conf.Validate if the designated constraints aren't met.

func (ConfValidationError) Cause

func (e ConfValidationError) Cause() error

Cause function returns cause value.

func (ConfValidationError) Error

func (e ConfValidationError) Error() string

Error satisfies the builtin error interface

func (ConfValidationError) ErrorName

func (e ConfValidationError) ErrorName() string

ErrorName returns error name.

func (ConfValidationError) Field

func (e ConfValidationError) Field() string

Field function returns field value.

func (ConfValidationError) Key

func (e ConfValidationError) Key() bool

Key function returns key value.

func (ConfValidationError) Reason

func (e ConfValidationError) Reason() string

Reason function returns reason value.

type Metadata

type Metadata struct{}

Metadata is tracing metadata propagator

func (Metadata) Extract

func (b Metadata) Extract(parent context.Context, carrier propagation.TextMapCarrier) context.Context

Extract returns a copy of parent with the metadata from the carrier added.

func (Metadata) Fields

func (b Metadata) Fields() []string

Fields returns the keys who's values are set with Inject.

func (Metadata) Inject

func (b Metadata) Inject(ctx context.Context, carrier propagation.TextMapCarrier)

Inject sets metadata key-values from ctx into the carrier.

type Option

type Option func(*options)

Option is tracing option.

func WithPropagator

func WithPropagator(propagator propagation.TextMapPropagator) Option

WithPropagator with tracer propagator.

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider with tracer provider. Deprecated: use otel.SetTracerProvider(provider) instead.

type TraceContext

type TraceContext struct{}

TraceContext is a propagator that supports the W3C Trace Context format (https://www.w3.org/TR/trace-context/)

This propagator will propagate the traceparent and tracestate headers to guarantee traces are not broken. It is up to the users of this propagator to choose if they want to participate in a trace by modifying the traceparent header and relevant parts of the tracestate header containing their proprietary information.

func (TraceContext) Extract

func (tc TraceContext) Extract(ctx context.Context, carrier propagation.TextMapCarrier) context.Context

Extract reads tracecontext from the carrier into a returned Context.

The returned Context will be a copy of ctx and contain the extracted tracecontext as the remote SpanContext. If the extracted tracecontext is invalid, the passed ctx will be returned directly instead.

func (TraceContext) Fields

func (tc TraceContext) Fields() []string

Fields returns the keys who's values are set with Inject.

func (TraceContext) Inject

func (tc TraceContext) Inject(ctx context.Context, carrier propagation.TextMapCarrier)

Inject set tracecontext from the Context into the carrier.

type Tracer

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

Tracer is otel span tracer

func NewTracer

func NewTracer(kind trace.SpanKind, opts ...Option) *Tracer

NewTracer create tracer instance

func (*Tracer) End

func (t *Tracer) End(ctx context.Context, span trace.Span, m interface{}, err error)

End finish tracing span

func (*Tracer) Start

func (t *Tracer) Start(ctx context.Context, operation string, carrier propagation.TextMapCarrier) (context.Context, trace.Span)

Start start tracing span