tracing

Documentation

Index

• Variables
• func Inject(ctx context.Context, h *http.Header)
• func Tag(ctx context.Context, key string, val interface{})
• func Trace(ctx context.Context, name string) (context.Context, func(err error, logs ...log.Field) error)
• type TraceConfig

Variables

var (
	// DefaultTraceConfig is the default Trace middleware config.
	DefaultTraceConfig = TraceConfig{
		Skipper:       middleware.DefaultSkipper,
		ComponentName: defaultComponentName,
		IsBodyDump:    false,
	}
)

Functions

func Inject

func Inject(ctx context.Context, h *http.Header)

func Tag

func Tag(ctx context.Context, key string, val interface{})

func Trace

func Trace(ctx context.Context, name string) (context.Context, func(err error, logs ...log.Field) error)

Types

type TraceConfig

type TraceConfig struct {
	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper

	// OpenTracing Tracer instance which should be got before
	Tracer opentracing.Tracer

	// ComponentName used for describing the tracing component name
	ComponentName string

	// add req body & resp body to tracing tags
	IsBodyDump bool
}

TraceConfig defines the config for Trace middleware.