processor

Documentation

Overview

Package processor exposes utilities to create a Flow component from OpenTelemetry Collector processors.

Index

• type Arguments
• type Processor
  • func New(opts component.Options, f otelcomponent.ProcessorFactory, args Arguments) (*Processor, error)
  • func (p *Processor) CurrentHealth() component.Health
  • func (p *Processor) Run(ctx context.Context) error
  • func (p *Processor) Update(args component.Arguments) error

Types

type Arguments

type Arguments interface {
	component.Arguments

	// Convert converts the Arguments into an OpenTelemetry Collector processor
	// configuration.
	Convert() otelconfig.Processor

	// Extensions returns the set of extensions that the configured component is
	// allowed to use.
	Extensions() map[otelconfig.ComponentID]otelcomponent.Extension

	// Exporters returns the set of exporters that are exposed to the configured
	// component.
	Exporters() map[otelconfig.DataType]map[otelconfig.ComponentID]otelcomponent.Exporter

	// NextConsumers returns the set of consumers to send data to.
	NextConsumers() *otelcol.ConsumerArguments
}

Arguments is an extension of component.Arguments which contains necessary settings for OpenTelemetry Collector processors.

type Processor

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

Processor is a Flow component shim which manages an OpenTelemetry Collector processor component.

func New

func New(opts component.Options, f otelcomponent.ProcessorFactory, args Arguments) (*Processor, error)

New creates a new Flow component which encapsulates an OpenTelemetry Collector processor. args must hold a value of the argument type registered with the Flow component.

The registered component must be registered to export the otelcol.ConsumerExports type, otherwise New will panic.

func (*Processor) CurrentHealth

func (p *Processor) CurrentHealth() component.Health

CurrentHealth implements component.HealthComponent.

func (*Processor) Run

func (p *Processor) Run(ctx context.Context) error

Run starts the Processor component.

func (*Processor) Update

func (p *Processor) Update(args component.Arguments) error

Update implements component.Component. It will convert the Arguments into configuration for OpenTelemetry Collector processor configuration and manage the underlying OpenTelemetry Collector processor.