downsample

Documentation

Index

• type Configuration
  • func (cfg Configuration) NewDownsampler(opts DownsamplerOptions) (Downsampler, error)
• type Downsampler
• type DownsamplerOptions
• type MappingRule
  • func (r MappingRule) StagedMetadatas() (metadata.StagedMetadatas, error)
• type MetricsAppender
• type SamplesAppender

Types

type Configuration

type Configuration struct {
	// AggregationTypes configs the aggregation types.
	AggregationTypes *aggregation.TypesConfiguration `yaml:"aggregationTypes"`

	// Pool of counter elements.
	CounterElemPool pool.ObjectPoolConfiguration `yaml:"counterElemPool"`

	// Pool of timer elements.
	TimerElemPool pool.ObjectPoolConfiguration `yaml:"timerElemPool"`

	// Pool of gauge elements.
	GaugeElemPool pool.ObjectPoolConfiguration `yaml:"gaugeElemPool"`
}

Configuration configurates a downsampler.

func (Configuration) NewDownsampler

func (cfg Configuration) NewDownsampler(
	opts DownsamplerOptions,
) (Downsampler, error)

NewDownsampler returns a new downsampler.

type Downsampler

type Downsampler interface {
	NewMetricsAppender() MetricsAppender
}

Downsampler is a downsampler.

type DownsamplerOptions

type DownsamplerOptions struct {
	Storage                 storage.Storage
	StorageFlushConcurrency int
	RulesKVStore            kv.Store
	AutoMappingRules        []MappingRule
	NameTag                 string
	ClockOptions            clock.Options
	InstrumentOptions       instrument.Options
	TagEncoderOptions       serialize.TagEncoderOptions
	TagDecoderOptions       serialize.TagDecoderOptions
	TagEncoderPoolOptions   pool.ObjectPoolOptions
	TagDecoderPoolOptions   pool.ObjectPoolOptions
	OpenTimeout             time.Duration
	TagOptions              models.TagOptions
}

DownsamplerOptions is a set of required downsampler options.

type MappingRule

type MappingRule struct {
	Aggregations []aggregation.Type
	Policies     policy.StoragePolicies
}

MappingRule is a mapping rule to apply to metrics.

func (MappingRule) StagedMetadatas

func (r MappingRule) StagedMetadatas() (metadata.StagedMetadatas, error)

StagedMetadatas returns the corresponding staged metadatas for this mapping rule.

type MetricsAppender

type MetricsAppender interface {
	AddTag(name, value []byte)
	SamplesAppender() (SamplesAppender, error)
	Reset()
	Finalize()
}

MetricsAppender is a metrics appender that can build a samples appender, only valid to use with a single caller at a time.

type SamplesAppender

type SamplesAppender interface {
	AppendCounterSample(value int64) error
	AppendGaugeSample(value float64) error
}

SamplesAppender is a downsampling samples appender, that can only be called by a single caller at a time.