cortex

Documentation

Index

• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) AddFlags(flagSet *flag.FlagSet)
  • func (f *Factory) CreateWriter() (metricstore.Writer, error)
  • func (f *Factory) InitFromOptions(o Options)
  • func (f *Factory) InitFromViper(v *viper.Viper)
  • func (f *Factory) Initialize(metricsFactory metrics.Factory, logger *zap.Logger) error
• type Marshaller
• type Options
  • func (o *Options) AddFlags(flagSet *flag.FlagSet)
  • func (o *Options) InitFromViper(v *viper.Viper)
• type Writer
  • func NewMetricWriter(logger *zap.Logger, factory metrics.Factory, options Options, ...) *Writer
  • func (w *Writer) WriteMetric(metric []prompb.TimeSeries) error
• type WriterMetrics

Types

type Factory

type Factory struct {
	// contains filtered or unexported fields
}

Factory implements storage.Factory and creates write-only storage components backed by kafka.

func NewFactory

func NewFactory() *Factory

NewFactory creates a new Factory.

func (*Factory) AddFlags

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

AddFlags implements plugin.Configurable

func (*Factory) CreateWriter

func (f *Factory) CreateWriter() (metricstore.Writer, error)

func (*Factory) InitFromOptions

func (f *Factory) InitFromOptions(o Options)

InitFromOptions initializes factory from options.

func (*Factory) InitFromViper

func (f *Factory) InitFromViper(v *viper.Viper)

InitFromViper implements plugin.Configurable

func (*Factory) Initialize

func (f *Factory) Initialize(metricsFactory metrics.Factory, logger *zap.Logger) error

type Marshaller

type Marshaller interface {
	MarshalMetric([]prompb.TimeSeries) ([]byte, error)
}

Marshaller encodes a metric into a byte array to be sent to Kafka

type Options

type Options struct {
	Encoding string
	// contains filtered or unexported fields
}

func (*Options) AddFlags

func (o *Options) AddFlags(flagSet *flag.FlagSet)

func (*Options) InitFromViper

func (o *Options) InitFromViper(v *viper.Viper)

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer writes metric to kafka. Implements metricstore.Writer

func NewMetricWriter

func NewMetricWriter(
	logger *zap.Logger,
	factory metrics.Factory,
	options Options,
	marshaller Marshaller,
) *Writer

func (*Writer) WriteMetric

func (w *Writer) WriteMetric(metric []prompb.TimeSeries) error

type WriterMetrics

type WriterMetrics struct {
	WrittenSuccess metrics.Counter
	WrittenFailure metrics.Counter
}