metrics

Documentation

Overview

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

Index

• type Builder
  • func (b *Builder) Bind(flagSet *flag.FlagSet)
  • func (b *Builder) CreateMetricsFactory(namespace string) (metrics.Factory, error)
  • func (b *Builder) RegisterHandler(mux *http.ServeMux)

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) Bind

func (b *Builder) Bind(flagSet *flag.FlagSet)

Bind defines command line flags and binds their values to the builder fields.

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) RegisterHandler

func (b *Builder) RegisterHandler(mux *http.ServeMux)

RegisterHandler adds an endpoint to the mux if the metrics backend supports it.