tracing

Documentation

Index

• Constants
• func AddHook(hook Hook) nirvana.Configurer
• func CustomTracer(tracer opentracing.Tracer) nirvana.Configurer
• func DefaultTracer(serviceName string, agentHostPort string) nirvana.Configurer
• func Disable() nirvana.Configurer
• type DefaultHook
  • func (h *DefaultHook) After(ctx context.Context, span opentracing.Span)
  • func (h *DefaultHook) Before(ctx context.Context, span opentracing.Span)
• type Hook
• type Option
  • func NewDefaultOption() *Option
  • func (p *Option) Configure(cfg *nirvana.Config) error
  • func (p *Option) Name() string

Constants

const ExternalConfigName = "tracing"

ExternalConfigName is the external config name of tracing.

const (
	// HeaderRequestID is request id
	HeaderRequestID = "X-Request-ID"
)

Functions

func AddHook

func AddHook(hook Hook) nirvana.Configurer

AddHook returns a configurer to set request hook.

func CustomTracer

func CustomTracer(tracer opentracing.Tracer) nirvana.Configurer

CustomTracer returns a configurer to set custom tracer.

func DefaultTracer

func DefaultTracer(serviceName string, agentHostPort string) nirvana.Configurer

DefaultTracer returns a configurer to create default tracer by service and port.

func Disable

func Disable() nirvana.Configurer

Disable returns a configurer to disable tracing.

Types

type DefaultHook

type DefaultHook struct{}

DefaultHook is an default hook, it will record X-Request-ID from http headers

func (*DefaultHook) After

func (h *DefaultHook) After(ctx context.Context, span opentracing.Span)

After Do nothing, because HTTP response can't gets payload.

func (*DefaultHook) Before

func (h *DefaultHook) Before(ctx context.Context, span opentracing.Span)

Before request processing

type Hook

type Hook interface {
	// Exec before request processing
	Before(ctx context.Context, span opentracing.Span)
	// Exec after request processing
	After(ctx context.Context, span opentracing.Span)
}

Hook allows you to custom information for span.

type Option

type Option struct {
	// ServiceName is the trace service name
	ServiceName string
	// AgentHostPort instructs reporter to send spans to jaeger-agent at this address
	AgentHostPort string
}

Option contains basic configurations of tracing.

func NewDefaultOption

func NewDefaultOption() *Option

NewDefaultOption creates default option.

func (*Option) Configure

func (p *Option) Configure(cfg *nirvana.Config) error

Configure configures nirvana config via current options.

func (*Option) Name

func (p *Option) Name() string

Name returns plugin name.