receiver

Documentation

Overview

Package receiver utilities to create a Flow component from OpenTelemetry Collector receivers.

Index

• type Arguments
• type Receiver
  • func New(opts component.Options, f otelreceiver.Factory, args Arguments) (*Receiver, error)
  • func (r *Receiver) CurrentHealth() component.Health
  • func (r *Receiver) Run(ctx context.Context) error
  • func (r *Receiver) Update(args component.Arguments) error

Types

type Arguments

type Arguments interface {
	component.Arguments

	// Convert converts the Arguments into an OpenTelemetry Collector receiver
	// configuration.
	Convert() (otelcomponent.Config, error)

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

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

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

	// DebugMetricsConfig returns the configuration for debug metrics
	DebugMetricsConfig() otelcol.DebugMetricsArguments
}

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

type Receiver

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

Receiver is a Flow component shim which manages an OpenTelemetry Collector receiver component.

func New

func New(opts component.Options, f otelreceiver.Factory, args Arguments) (*Receiver, error)

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

If the registered Flow component registers exported fields, it is the responsibility of the caller to export values when needed; the Receiver component never exports any values.

func (*Receiver) CurrentHealth

func (r *Receiver) CurrentHealth() component.Health

CurrentHealth implements component.HealthComponent.

func (*Receiver) Run

func (r *Receiver) Run(ctx context.Context) error

Run starts the Receiver component.

func (*Receiver) Update

func (r *Receiver) Update(args component.Arguments) error

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