options

Documentation

Overview

Package options defines data structure for common surfacer options.

Index

• type Options
  • func BuildOptionsForTest(sdef *surfacerpb.SurfacerDef) *Options
  • func BuildOptionsFromConfig(sdef *surfacerpb.SurfacerDef, l *logger.Logger) (*Options, error)
  • func (opts *Options) AllowEventMetrics(em *metrics.EventMetrics) bool
  • func (opts *Options) AllowMetric(metricName string) bool
  • func (opts *Options) IgnoreMetric(metricName string) bool
  • func (opts *Options) IsLatencyMetric(metricName string) bool

Types

type Options

type Options struct {
	MetricsBufferSize int
	Config            *surfacerpb.SurfacerDef
	Logger            *logger.Logger

	AddFailureMetric bool

	AdditionalLabels [][2]string
	// contains filtered or unexported fields
}

Options encapsulates surfacer options common to all surfacers.

func BuildOptionsForTest

func BuildOptionsForTest(sdef *surfacerpb.SurfacerDef) *Options

BuildOptionsForTest builds surfacer options using config for tests.

func BuildOptionsFromConfig

func BuildOptionsFromConfig(sdef *surfacerpb.SurfacerDef, l *logger.Logger) (*Options, error)

BuildOptionsFromConfig builds surfacer options using config.

func (*Options) AllowEventMetrics

func (opts *Options) AllowEventMetrics(em *metrics.EventMetrics) bool

AllowEventMetrics returns whether a certain EventMetrics should be allowed or not. TODO(manugarg): Explore if we can either log or increment some metric when we ignore an EventMetrics.

func (*Options) AllowMetric

func (opts *Options) AllowMetric(metricName string) bool

AllowMetric returns whether a certain Metric should be allowed or not.

func (*Options) IgnoreMetric

func (opts *Options) IgnoreMetric(metricName string) bool

func (*Options) IsLatencyMetric

func (opts *Options) IsLatencyMetric(metricName string) bool