disabled

Documentation

Index

• Variables
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) AddFlags(_ *flag.FlagSet)
  • func (f *Factory) CreateMetricsReader() (metricsstore.Reader, error)
  • func (f *Factory) InitFromViper(_ *viper.Viper, _ *zap.Logger)
  • func (f *Factory) Initialize(_ *zap.Logger) error
• type MetricsReader
  • func NewMetricsReader() (*MetricsReader, error)
  • func (m *MetricsReader) GetCallRates(ctx context.Context, requestParams *metricsstore.CallRateQueryParameters) (*metrics.MetricFamily, error)
  • func (m *MetricsReader) GetErrorRates(ctx context.Context, requestParams *metricsstore.ErrorRateQueryParameters) (*metrics.MetricFamily, error)
  • func (m *MetricsReader) GetLatencies(ctx context.Context, requestParams *metricsstore.LatenciesQueryParameters) (*metrics.MetricFamily, error)
  • func (m *MetricsReader) GetMinStepDuration(_ context.Context, _ *metricsstore.MinStepDurationQueryParameters) (time.Duration, error)

Variables

var ErrDisabled = &errMetricsQueryDisabled{}

ErrDisabled is the error returned by a "disabled" MetricsQueryService on all of its endpoints.

Types

type Factory

type Factory struct{}

Factory implements storage.Factory that returns a Disabled metrics reader.

func NewFactory

func NewFactory() *Factory

NewFactory creates a new Factory.

func (*Factory) AddFlags

func (f *Factory) AddFlags(_ *flag.FlagSet)

AddFlags implements plugin.Configurable.

func (*Factory) CreateMetricsReader

func (f *Factory) CreateMetricsReader() (metricsstore.Reader, error)

CreateMetricsReader implements storage.MetricsFactory.

func (*Factory) InitFromViper

func (f *Factory) InitFromViper(_ *viper.Viper, _ *zap.Logger)

InitFromViper implements plugin.Configurable.

func (*Factory) Initialize

func (f *Factory) Initialize(_ *zap.Logger) error

Initialize implements storage.MetricsFactory.

type MetricsReader

type MetricsReader struct{}

MetricsReader represents a "disabled" metricsstore.Reader implementation where the METRICS_STORAGE_TYPE has not been set.

func NewMetricsReader

func NewMetricsReader() (*MetricsReader, error)

NewMetricsReader returns a new Disabled MetricsReader.

func (*MetricsReader) GetCallRates

func (m *MetricsReader) GetCallRates(ctx context.Context, requestParams *metricsstore.CallRateQueryParameters) (*metrics.MetricFamily, error)

GetCallRates gets the call rate metrics for the given set of call rate query parameters.

func (*MetricsReader) GetErrorRates

func (m *MetricsReader) GetErrorRates(ctx context.Context, requestParams *metricsstore.ErrorRateQueryParameters) (*metrics.MetricFamily, error)

GetErrorRates gets the error rate metrics for the given set of error rate query parameters.

func (*MetricsReader) GetLatencies

func (m *MetricsReader) GetLatencies(ctx context.Context, requestParams *metricsstore.LatenciesQueryParameters) (*metrics.MetricFamily, error)

GetLatencies gets the latency metrics for the given set of latency query parameters.

func (*MetricsReader) GetMinStepDuration

func (m *MetricsReader) GetMinStepDuration(_ context.Context, _ *metricsstore.MinStepDurationQueryParameters) (time.Duration, error)

GetMinStepDuration gets the minimum step duration (the smallest possible duration between two data points in a time series) supported.