http_opentracing

Documentation

Overview

`http_opentracing` adds OpenTracing wares for HTTP libraries.

OpenTracing Wares

These are both client-side and server-side wares for OpenTracing. They are a provider-agnostic, with backends such as Zipkin, or Google Stackdriver Trace.

For a service that sends out requests and receives requests, you *need* to use both, otherwise downstream requests will not have the appropriate requests propagated.

All server-side spans are tagged with http_ctxtags information.

For more information see: http://opentracing.io/documentation/ https://github.com/opentracing/specification/blob/master/semantic_conventions.md

Index

• Constants
• func DefaultStatusCodeIsError(statusCode int) bool
• func Middleware(opts ...Option) httpwares.Middleware
• func Tripperware(opts ...Option) httpwares.Tripperware
• type FilterFunc
• type Option
  • func WithFilterFunc(f FilterFunc) Option
  • func WithStatusCodeIsError(f StatusCodeIsError) Option
  • func WithTracer(tracer opentracing.Tracer) Option
• type StatusCodeIsError

Constants

const (
	TagTraceId = "trace.traceid"
	TagSpanId  = "trace.spanid"
)

Functions

func DefaultStatusCodeIsError

func DefaultStatusCodeIsError(statusCode int) bool

func Middleware

func Middleware(opts ...Option) httpwares.Middleware

Middleware returns a http.Handler middleware values for request tags.

func Tripperware

func Tripperware(opts ...Option) httpwares.Tripperware

Tripperware returns a piece of client-side Tripperware that forwards opentracing tokens.

Types

type FilterFunc

type FilterFunc func(req *http.Request) bool

FilterFunc allows users to provide a function that filters out certain methods from being traced.

If it returns false, the given request will not be traced.

type Option

type Option func(*options)

func WithFilterFunc

func WithFilterFunc(f FilterFunc) Option

WithFilterFunc customizes the function used for deciding whether a given call is traced or not.

func WithStatusCodeIsError

func WithStatusCodeIsError(f StatusCodeIsError) Option

WithStatusCodeIsError customizes the function used for deciding whether a given call was an error

func WithTracer

func WithTracer(tracer opentracing.Tracer) Option

WithTracer sets a custom tracer to be used for this middleware, otherwise the opentracing.GlobalTracer is used.

type StatusCodeIsError

type StatusCodeIsError func(statusCode int) bool

StatusCodeIsError allows the customization of which requests are considered errors in the tracing system.