deltatorateprocessor

README

Delta to Rate Processor

Status
Stability	alpha: metrics
Distributions	contrib, k8s
Issues
Code Owners	@Aneurysm9

Status: under development; Not recommended for production usage.

Description

The delta to rate processor (deltatorateprocessor) converts delta sum metrics to rate metrics. This rate is a gauge.

Configuration

Configuration is specified through a list of metrics. The processor uses metric names to identify a set of delta sum metrics and calculates the rates which are gauges.

processors:
    # processor name: deltatorate
    deltatorate:

        # list the delta sum metrics to calculate the rate. This is a required field.
        metrics:
            - <metric_1_name>
            - <metric_2_name>
            .
            .
            - <metric_n_name>

Documentation

Overview

package deltatorateprocessor implements a processor which converts delta sum metrics to rates.

Index

• func NewFactory() processor.Factory
• type Config
  • func (config *Config) Validate() error

Functions

func NewFactory

func NewFactory() processor.Factory

NewFactory returns a new factory for the Delta to Rate processor.

Types

type Config

type Config struct {
	// List of delta sum metrics to convert to rates
	Metrics []string `mapstructure:"metrics"`
}

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.