validation

Documentation

Index

• Variables
• type Config
  • func (cfg *Config) RegisterFlags(f *flag.FlagSet)
  • func (cfg *Config) ValidateLabels(ls []client.LabelPair) error
  • func (cfg *Config) ValidateSample(metricName []byte, s client.Sample) error

Variables

var DiscardedSamples = prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Name: "cortex_discarded_samples_total",
		Help: "The total number of samples that were discarded.",
	},
	[]string{discardReasonLabel},
)

DiscardedSamples is a metric of the number of discarded samples, by reason.

Types

type Config

type Config struct {
	// maximum length a label name can be
	MaxLabelNameLength int

	// maximum length a label value can be. This also is the maximum length of a metric name.
	MaxLabelValueLength int

	// maximum number of label/value pairs timeseries.
	MaxLabelNamesPerSeries int

	// Config for rejecting old samples.
	RejectOldSamples       bool
	RejectOldSamplesMaxAge time.Duration
	CreationGracePeriod    time.Duration
}

Config for validation settings and options.

func (*Config) RegisterFlags

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers a set of command line flags for setting options regarding sample validation at ingestion time.

func (*Config) ValidateLabels

func (cfg *Config) ValidateLabels(ls []client.LabelPair) error

ValidateLabels returns an err if the labels are invalid.

func (*Config) ValidateSample

func (cfg *Config) ValidateSample(metricName []byte, s client.Sample) error

ValidateSample returns an err if the sample is invalid.