tracing

Documentation

Index

• Variables
• func HTTPSpanIgnoringPaths(pathsToIgnore ...string) func(http.Handler) http.Handler
• type ConfigOption
  • func WithExporter(name string, logger *zap.SugaredLogger) ConfigOption
  • func WithZipkinExporter(reporterFact ZipkinReporterFactory, endpoint *zipkinmodel.Endpoint) ConfigOption
• type OpenCensusTracer
  • func NewOpenCensusTracer(configOptions ...ConfigOption) *OpenCensusTracer
  • func (oct *OpenCensusTracer) ApplyConfig(cfg *config.Config) error
  • func (oct *OpenCensusTracer) Finish() error
• type ZipkinReporterFactory

Variables

var (

	// HTTPSpanMiddleware is an http.Handler middleware to create spans for the HTTP endpoint.
	HTTPSpanMiddleware = HTTPSpanIgnoringPaths()
)

Functions

func HTTPSpanIgnoringPaths

func HTTPSpanIgnoringPaths(pathsToIgnore ...string) func(http.Handler) http.Handler

HTTPSpanIgnoringPaths is an http.Handler middleware to create spans for the HTTP endpoint, not sampling any request whose path is in pathsToIgnore.

Types

type ConfigOption

type ConfigOption func(*config.Config) error

ConfigOption is the interface for adding additional exporters and configuring opencensus tracing.

func WithExporter

func WithExporter(name string, logger *zap.SugaredLogger) ConfigOption

WithExporter returns a ConfigOption for use with NewOpenCensusTracer that configures it to export traces based on the configuration read from config-tracing.

func WithZipkinExporter

func WithZipkinExporter(reporterFact ZipkinReporterFactory, endpoint *zipkinmodel.Endpoint) ConfigOption

DEPRECATED: This function is the legacy entrypoint and should be replaced with one of:

• WithExporter() in production code
• testing/FakeZipkinExporter() in test code.

type OpenCensusTracer

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

OpenCensusTracer is responsible for managing and updating configuration of OpenCensus tracing

func NewOpenCensusTracer

func NewOpenCensusTracer(configOptions ...ConfigOption) *OpenCensusTracer

func (*OpenCensusTracer) ApplyConfig

func (oct *OpenCensusTracer) ApplyConfig(cfg *config.Config) error

func (*OpenCensusTracer) Finish

func (oct *OpenCensusTracer) Finish() error

type ZipkinReporterFactory

type ZipkinReporterFactory func(*config.Config) (zipkinreporter.Reporter, error)

ZipkinReporterFactory is a factory function which creates a reporter given a config