memorylimiter

Documentation

Overview

Package memorylimiter provides an otelcol.processor.memory_limiter component.

Index

• Variables
• type Arguments
  • func (args Arguments) Convert() (otelconfig.Processor, error)
  • func (args Arguments) Exporters() map[otelconfig.DataType]map[otelconfig.ComponentID]otelcomponent.Exporter
  • func (args Arguments) Extensions() map[otelconfig.ComponentID]otelcomponent.Extension
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) UnmarshalRiver(f func(interface{}) error) error

Variables

var DefaultArguments = Arguments{
	CheckInterval:         0,
	MemoryLimit:           0,
	MemorySpikeLimit:      0,
	MemoryLimitPercentage: 0,
	MemorySpikePercentage: 0,
}

DefaultArguments holds default settings for Arguments.

Types

type Arguments

type Arguments struct {
	CheckInterval         time.Duration    `river:"check_interval,attr"`
	MemoryLimit           units.Base2Bytes `river:"limit,attr,optional"`
	MemorySpikeLimit      units.Base2Bytes `river:"spike_limit,attr,optional"`
	MemoryLimitPercentage uint32           `river:"limit_percentage,attr,optional"`
	MemorySpikePercentage uint32           `river:"spike_limit_percentage,attr,optional"`

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

Arguments configures the otelcol.processor.memory_limiter component.

func (Arguments) Convert

func (args Arguments) Convert() (otelconfig.Processor, error)

Convert implements processor.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[otelconfig.DataType]map[otelconfig.ComponentID]otelcomponent.Exporter

Exporters implements processor.Arguments.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelconfig.ComponentID]otelcomponent.Extension

Extensions implements processor.Arguments.

func (Arguments) NextConsumers

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

NextConsumers implements processor.Arguments.

func (*Arguments) UnmarshalRiver

func (args *Arguments) UnmarshalRiver(f func(interface{}) error) error

UnmarshalRiver implements river.Unmarshaler. It applies defaults to args and validates settings provided by the user.