bjaeger

README

bjaeger

Jaeger brick to be used by Mortar

Documentation

Index

• Constants
• func BricksLoggerOption(bricksLogger log.Logger) config.Option
• func TraceInfoContextExtractorFxOption() fx.Option
• func TraceInfoExtractorFromContext(ctx context.Context) map[string]interface{}
• type JaegerBuilder
  • func Builder() JaegerBuilder

Constants

const (
	// TraceIDKey key used in log
	TraceIDKey = "traceId"
	// SpanIDKey key used in log
	SpanIDKey = "spanId"
	// ParentSpanIDKey key used in log
	ParentSpanIDKey = "parentSpanId"
	// SampledKey key used in log
	SampledKey = "sampled"
)

Functions

func BricksLoggerOption

func BricksLoggerOption(bricksLogger log.Logger) config.Option

BricksLoggerOption can be added to enable jaeger client debug using mortar logger

func TraceInfoContextExtractorFxOption

func TraceInfoContextExtractorFxOption() fx.Option

TraceInfoContextExtractorFxOption is a preconfigured fx.Option that will allow adding trace info to log entry

func TraceInfoExtractorFromContext

func TraceInfoExtractorFromContext(ctx context.Context) map[string]interface{}

TraceInfoExtractorFromContext helper function to extract trace info from context

Types

type JaegerBuilder

type JaegerBuilder interface {
	SetServiceName(name string) JaegerBuilder
	AddOptions(options ...config.Option) JaegerBuilder
	SetCustomConfig(custom *config.Configuration) JaegerBuilder
	Build() (trace.OpenTracer, error)
}

JaegerBuilder is a builder that will help you configure jaeger

func Builder

func Builder() JaegerBuilder

Builder start building Jaeger instance