metrics

Documentation

Overview

Package metrics provides command line flags for configuring the metrics backend.

Index

• func AddFlags(flags *flag.FlagSet)
• type Builder
  • func (b *Builder) CreateMetricsFactory(namespace string) (metrics.Factory, error)
  • func (b *Builder) Handler() http.Handler
  • func (b *Builder) InitFromViper(v *viper.Viper) *Builder

Functions

func AddFlags

func AddFlags(flags *flag.FlagSet)

AddFlags adds flags for Builder.

Types

type Builder

type Builder struct {
	Backend   string
	HTTPRoute string // endpoint name to expose metrics, e.g. for scraping
	// contains filtered or unexported fields
}

Builder provides command line options to configure metrics backend used by Jaeger executables.

func (*Builder) CreateMetricsFactory

func (b *Builder) CreateMetricsFactory(namespace string) (metrics.Factory, error)

CreateMetricsFactory creates a metrics factory based on the configured type of the backend. If the metrics backend supports HTTP endpoint for scraping, it is stored in the builder and can be later added by RegisterHandler function.

func (*Builder) Handler

func (b *Builder) Handler() http.Handler

Handler returns an http.Handler for the metrics endpoint.

func (*Builder) InitFromViper

func (b *Builder) InitFromViper(v *viper.Viper) *Builder

InitFromViper initializes Builder with properties retrieved from Viper.