connector

Documentation

Overview

Package connector exposes utilities to create an Alloy component from OpenTelemetry Collector connectors.

Index

• Constants
• type Arguments
• type Connector
  • func New(opts component.Options, f otelconnector.Factory, args Arguments) (*Connector, error)
  • func (p *Connector) CurrentHealth() component.Health
  • func (p *Connector) Run(ctx context.Context) error
  • func (p *Connector) Update(args component.Arguments) error

Constants

const (
	ConnectorTracesToTraces = iota
	ConnectorTracesToMetrics
	ConnectorTracesToLogs
	ConnectorMetricsToTraces
	ConnectorMetricsToMetrics
	ConnectorMetricsToLogs
	ConnectorLogsToTraces
	ConnectorLogsToMetrics
	ConnectorLogsToLogs
)

Types

type Arguments

type Arguments interface {
	component.Arguments

	// Convert converts the Arguments into an OpenTelemetry Collector connector
	// 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

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

	ConnectorType() int

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

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

type Connector

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

Connector is an Alloy component shim which manages an OpenTelemetry Collector connector component.

func New

func New(opts component.Options, f otelconnector.Factory, args Arguments) (*Connector, error)

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

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

func (*Connector) CurrentHealth

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

CurrentHealth implements component.HealthComponent.

func (*Connector) Run

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

Run starts the Connector component.

func (*Connector) Update

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

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