extension

Documentation

Overview

Package extension provides utilities to create an Alloy component from OpenTelemetry Collector extensions.

Other OpenTelemetry Collector extensions are better served as generic Alloy components rather than being placed in the otelcol namespace.

Index

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

Types

type Arguments

type Arguments interface {
	component.Arguments

	// Convert converts the Arguments into an OpenTelemetry Collector
	// extension 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[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component

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

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

type Extension

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

Extension is an Alloy component shim which manages an OpenTelemetry Collector extension.

func New

func New(opts component.Options, f otelextension.Factory, args Arguments) (*Extension, error)

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

func (*Extension) CurrentHealth

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

CurrentHealth implements component.HealthComponent.

func (*Extension) Run

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

Run starts the Extension component.

func (*Extension) Update

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

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