exporter

Documentation

Overview

Package exporter exposes utilities to create a Flow component from OpenTelemetry Collector exporters.

Index

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

Types

type Arguments

type Arguments interface {
	component.Arguments

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

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

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

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

type Exporter

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

Exporter is a Flow component shim which manages an OpenTelemetry Collector exporter component.

func New

func New(opts component.Options, f otelexporter.Factory, args Arguments) (*Exporter, error)

New creates a new Flow component which encapsulates an OpenTelemetry Collector exporter. 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 (*Exporter) CurrentHealth

func (e *Exporter) CurrentHealth() component.Health

CurrentHealth implements component.HealthComponent.

func (*Exporter) Run

func (e *Exporter) Run(ctx context.Context) error

Run starts the Exporter component.

func (*Exporter) Update

func (e *Exporter) Update(args component.Arguments) error

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