pitbullprocessor

README

pitbullprocessor

This processor is one of the main workhorses in the Cardinal Ecosystem. It's role is to apply rules obtained from its defined chqconfig extension to the telemetry passing through it. This can cause logs and spans to be sampled, dropped, or transformed. Metrics can be aggregated or dropped entirely, or otherwise transformed.

Each incoming rule is applied in order to the telemetry items received and then statements are applied. Sampling of logs is handled specially, as is dropping telemetry entirely.

All rules are written in OTTL, with some specific attributes set to indicate dropping the entire item or that a datapoint should be aggregated after removing an attribute.

Configuration

processors:
  pitbull/8bf0a2e0-8cc3-405e-9915-8eb8da17aadc:
    configuration_extension: "chqconfig"

All rule configuration is obtained dynamically at run-time from the named chqconfig extension.

Documentation

Index

• func NewFactory() xprocessor.Factory
• type Config
  • func (c *Config) Validate() error
• type ContextID
• type LogsConfig
  • func (cfg *LogsConfig) Validate() error
• type MetricAggregationConfig
  • func (c *MetricAggregationConfig) Validate() error
• type MetricsConfig
• type StatsEnrichment
• type TracesConfig
  • func (tc *TracesConfig) Validate() error

Functions

func NewFactory

func NewFactory() xprocessor.Factory

NewFactory returns a new factory for the Pitbull processor.

Types

type Config

type Config struct {
	MetricAggregation      MetricAggregationConfig `mapstructure:"metric_aggregation"`
	LogsConfig             LogsConfig              `mapstructure:"logs"`
	TracesConfig           TracesConfig            `mapstructure:"traces"`
	MetricsConfig          MetricsConfig           `mapstructure:"metrics"`
	ConfigurationExtension *component.ID           `mapstructure:"configuration_extension"`
}

Config defines configuration for Pitbull processor.

func (*Config) Validate

func (c *Config) Validate() error

type ContextID

type ContextID string

type LogsConfig

type LogsConfig struct {
	StatsEnrichments []StatsEnrichment `mapstructure:"stats_enrichments"`
}

func (*LogsConfig) Validate

func (cfg *LogsConfig) Validate() error

Validate function for LogsConfig

type MetricAggregationConfig

type MetricAggregationConfig struct {
	Interval time.Duration `mapstructure:"interval"`
}

func (*MetricAggregationConfig) Validate

func (c *MetricAggregationConfig) Validate() error

type MetricsConfig

type MetricsConfig struct {
	StatsEnrichments []StatsEnrichment `mapstructure:"stats_enrichments"`
}

type StatsEnrichment

type StatsEnrichment struct {
	Context ContextID `mapstructure:"context"`
	Tags    []string  `mapstructure:"tags"`
}

type TracesConfig

type TracesConfig struct {
	StatsEnrichments    []StatsEnrichment `mapstructure:"stats_enrichments"`
	EstimatorWindowSize int               `mapstructure:"estimator_window_size"`
	EstimatorInterval   int64             `mapstructure:"estimator_interval"`
}

func (*TracesConfig) Validate

func (tc *TracesConfig) Validate() error