reporter

Documentation

Index

• func AddFlags(flags *flag.FlagSet)
• type ClientMetricsReporter
  • func WrapWithClientMetrics(params ClientMetricsReporterParams) *ClientMetricsReporter
  • func (r *ClientMetricsReporter) Close() error
  • func (r *ClientMetricsReporter) EmitBatch(ctx context.Context, batch *jaeger.Batch) error
  • func (r *ClientMetricsReporter) EmitZipkinBatch(ctx context.Context, spans []*zipkincore.Span) error
• type ClientMetricsReporterParams
• type MetricsReporter
  • func WrapWithMetrics(reporter Reporter, mFactory metrics.Factory) *MetricsReporter
  • func (r *MetricsReporter) EmitBatch(ctx context.Context, batch *jaeger.Batch) error
  • func (r *MetricsReporter) EmitZipkinBatch(ctx context.Context, spans []*zipkincore.Span) error
• type MultiReporter
  • func NewMultiReporter(reps ...Reporter) MultiReporter
  • func (mr MultiReporter) EmitBatch(ctx context.Context, batch *jaeger.Batch) error
  • func (mr MultiReporter) EmitZipkinBatch(ctx context.Context, spans []*zipkincore.Span) error
• type Options
  • func (b *Options) InitFromViper(v *viper.Viper, logger *zap.Logger) *Options
• type Reporter
• type Type

Functions

func AddFlags

func AddFlags(flags *flag.FlagSet)

AddFlags adds flags for Options.

Types

type ClientMetricsReporter

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

ClientMetricsReporter is a decorator that emits data loss metrics on behalf of clients. The clients must send a Process.Tag `client-uuid` with a unique string for each client instance.

func WrapWithClientMetrics

func WrapWithClientMetrics(params ClientMetricsReporterParams) *ClientMetricsReporter

WrapWithClientMetrics creates ClientMetricsReporter.

func (*ClientMetricsReporter) Close

func (r *ClientMetricsReporter) Close() error

Close stops background gc goroutine for client stats map.

func (*ClientMetricsReporter) EmitBatch

func (r *ClientMetricsReporter) EmitBatch(ctx context.Context, batch *jaeger.Batch) error

EmitBatch processes client data loss metrics and delegates to the underlying reporter.

func (*ClientMetricsReporter) EmitZipkinBatch

func (r *ClientMetricsReporter) EmitZipkinBatch(ctx context.Context, spans []*zipkincore.Span) error

EmitZipkinBatch delegates to underlying Reporter.

type ClientMetricsReporterParams

type ClientMetricsReporterParams struct {
	Reporter        Reporter        // required
	Logger          *zap.Logger     // required
	MetricsFactory  metrics.Factory // required
	ExpireFrequency time.Duration
	ExpireTTL       time.Duration
}

ClientMetricsReporterParams is used as input to WrapWithClientMetrics.

type MetricsReporter

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

MetricsReporter is reporter with metrics integration.

func WrapWithMetrics

func WrapWithMetrics(reporter Reporter, mFactory metrics.Factory) *MetricsReporter

WrapWithMetrics wraps Reporter and creates metrics for its invocations.

func (*MetricsReporter) EmitBatch

func (r *MetricsReporter) EmitBatch(ctx context.Context, batch *jaeger.Batch) error

EmitBatch emits batch to collector.

func (*MetricsReporter) EmitZipkinBatch

func (r *MetricsReporter) EmitZipkinBatch(ctx context.Context, spans []*zipkincore.Span) error

EmitZipkinBatch emits batch to collector.

type MultiReporter

type MultiReporter []Reporter

MultiReporter provides serial span emission to one or more reporters. If more than one expensive reporter are needed, one or more of them should be wrapped and hidden behind a channel.

func NewMultiReporter

func NewMultiReporter(reps ...Reporter) MultiReporter

NewMultiReporter creates a MultiReporter from the variadic list of passed Reporters.

func (MultiReporter) EmitBatch

func (mr MultiReporter) EmitBatch(ctx context.Context, batch *jaeger.Batch) error

EmitBatch calls each EmitBatch, returning the first error.

func (MultiReporter) EmitZipkinBatch

func (mr MultiReporter) EmitZipkinBatch(ctx context.Context, spans []*zipkincore.Span) error

EmitZipkinBatch calls each EmitZipkinBatch, returning the first error.

type Options

type Options struct {
	ReporterType Type
	AgentTags    map[string]string
}

Options holds generic reporter configuration.

func (*Options) InitFromViper

func (b *Options) InitFromViper(v *viper.Viper, logger *zap.Logger) *Options

InitFromViper initializes Options with properties retrieved from Viper.

type Reporter

type Reporter interface {
	EmitZipkinBatch(ctx context.Context, spans []*zipkincore.Span) (err error)
	EmitBatch(ctx context.Context, batch *jaeger.Batch) (err error)
}

Reporter handles spans received by Processor and forwards them to central collectors.

type Type

type Type string

Type defines type of reporter.

const (

	// AgentTagsDeprecated is a configuration property name for adding process tags to incoming spans.
	AgentTagsDeprecated = "jaeger.tags"

	// GRPC is name of gRPC reporter.
	GRPC Type = "grpc"
)