auth

Documentation

Overview

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

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

Index

• func NormalizeType(in string) string
• type Arguments
• type Auth
  • func New(opts component.Options, f otelextension.Factory, args Arguments) (*Auth, error)
  • func (a *Auth) CurrentHealth() component.Health
  • func (a *Auth) Run(ctx context.Context) error
  • func (a *Auth) Update(args component.Arguments) error
• type Exports
• type Handler
  • func (Handler) AlloyCapsule()

Functions

func NormalizeType

func NormalizeType(in string) string

Types

type Arguments

type Arguments interface {
	component.Arguments

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

type Auth

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

Auth is an Alloy component shim which manages an OpenTelemetry Collector authentication extension.

func New

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

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

The registered component must be registered to export the Exports type from this package, otherwise New will panic.

func (*Auth) CurrentHealth

func (a *Auth) CurrentHealth() component.Health

CurrentHealth implements component.HealthComponent.

func (*Auth) Run

func (a *Auth) Run(ctx context.Context) error

Run starts the Auth component.

func (*Auth) Update

func (a *Auth) Update(args component.Arguments) error

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

type Exports

type Exports struct {
	// Handler is the managed component. Handler is updated any time the
	// extension is updated.
	Handler Handler `alloy:"handler,attr"`
}

Exports is a common Exports type for Alloy components which expose OpenTelemetry Collector authentication extensions.

type Handler

type Handler struct {
	ID        otelcomponent.ID
	Extension otelextension.Extension
}

Handler combines an extension with its ID.

func (Handler) AlloyCapsule

func (Handler) AlloyCapsule()

AlloyCapsule marks Handler as a capsule type.