interval

Documentation

Overview

Package interval provides an otelcol.processor.interval component.

Index

• Variables
• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) SetToDefault()
  • func (args *Arguments) Validate() error
• type PassThrough
  • func (args PassThrough) Convert() intervalprocessor.PassThrough

Variables

var DefaultArguments = Arguments{
	Interval: 60 * time.Second,
}

DefaultArguments holds default settings for Arguments.

Types

type Arguments

type Arguments struct {
	// The interval in which the processor should export the aggregated metrics. Default: 60s.
	Interval time.Duration `alloy:"interval,attr,optional"`

	PassThrough PassThrough `alloy:"passthrough,block,optional"`

	// Output configures where to send processed data. Required.
	Output *otelcol.ConsumerArguments `alloy:"output,block"`

	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`
}

func (Arguments) Convert

func (args Arguments) Convert() (otelcomponent.Config, error)

Convert implements processor.Arguments.

func (Arguments) DebugMetricsConfig

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements processor.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component

Exporters implements processor.Arguments.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension

Extensions implements processor.Arguments.

func (Arguments) NextConsumers

func (args Arguments) NextConsumers() *otelcol.ConsumerArguments

NextConsumers implements processor.Arguments.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implements syntax.Validator.

type PassThrough

type PassThrough struct {
	// Determines whether gauge metrics should be passed through as they are or aggregated.
	Gauge bool `alloy:"gauge,attr,optional"`
	// Determines whether summary metrics should be passed through as they are or aggregated.
	Summary bool `alloy:"summary,attr,optional"`
}

func (PassThrough) Convert

func (args PassThrough) Convert() intervalprocessor.PassThrough