intervalprocessor

README

Interval Processor

Status
Stability	development: metrics
Distributions	[]
Warnings	Statefulness
Issues
Code Owners	@RichieSams

Description

The interval processor (intervalprocessor) aggregates metrics and periodically forwards the latest values to the next component in the pipeline. The processor supports aggregating the following metric types:

• Monotonically increasing, cumulative sums
• Monotonically increasing, cumulative histograms
• Monotonically increasing, cumulative exponential histograms

The following metric types will not be aggregated, and will instead be passed, unchanged, to the next component in the pipeline:

• All delta metrics
• Non-monotonically increasing sums
• Gauges
• Summaries

Configuration

The following settings can be optionally configured:

• max_staleness: The total time a state entry will live past the time it was last seen. Set to 0 to retain state indefinitely. Default: 0

Documentation

Overview

package intervalprocessor implements a processor which aggregates cumulative metrics over time, and periodically exports the latest values

Index

• func NewFactory() processor.Factory
• type Config
  • func (config *Config) Validate() error
• type Processor
  • func (p *Processor) Capabilities() consumer.Capabilities
  • func (p *Processor) ConsumeMetrics(ctx context.Context, md pmetric.Metrics) error
  • func (p *Processor) Shutdown(_ context.Context) error
  • func (p *Processor) Start(_ context.Context, _ component.Host) error

Functions

func NewFactory

func NewFactory() processor.Factory

NewFactory returns a new factory for the Metrics Generation processor.

Types

type Config

type Config struct {
	// MaxStaleness is the total time a state entry will live past the time it was last seen. Set to 0 to retain state indefinitely.
	MaxStaleness time.Duration `mapstructure:"max_staleness"`
}

Config defines the configuration for the processor.

func (*Config) Validate

func (config *Config) Validate() error

Validate checks whether the input configuration has all of the required fields for the processor. An error is returned if there are any invalid inputs.

type Processor

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

func (*Processor) Capabilities

func (p *Processor) Capabilities() consumer.Capabilities

func (*Processor) ConsumeMetrics

func (p *Processor) ConsumeMetrics(ctx context.Context, md pmetric.Metrics) error

func (*Processor) Shutdown

func (p *Processor) Shutdown(_ context.Context) error

func (*Processor) Start

func (p *Processor) Start(_ context.Context, _ component.Host) error