basic

package
v1.14.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package basic provides an otelcol.auth.basic component.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Arguments

type Arguments struct {
	Username string            `alloy:"username,attr,optional"` // Deprecated: Use ClientAuth instead
	Password alloytypes.Secret `alloy:"password,attr,optional"` // Deprecated: Use ClientAuth instead

	ClientAuth *ClientAuthConfig `alloy:"client_auth,block,optional"`

	Htpasswd *HtpasswdConfig `alloy:"htpasswd,block,optional"`

	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`
}

Arguments configures the otelcol.auth.basic component.

func (Arguments) AuthFeatures added in v1.6.0

func (args Arguments) AuthFeatures() auth.AuthFeature

AuthFeatures implements auth.Arguments.

func (Arguments) ConvertClient added in v1.6.0

func (args Arguments) ConvertClient() (otelcomponent.Config, error)

ConvertClient implements auth.Arguments.

func (Arguments) ConvertServer added in v1.6.0

func (args Arguments) ConvertServer() (otelcomponent.Config, error)

ConvertServer implements auth.Arguments.

func (Arguments) DebugMetricsConfig added in v1.2.0

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements auth.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component

Exporters implements auth.Arguments.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelcomponent.ID]otelcomponent.Component

Extensions implements auth.Arguments.

func (*Arguments) SetToDefault added in v1.2.0

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (Arguments) Validate added in v1.13.0

func (args Arguments) Validate() error

Validate implements syntax.Validator

type ClientAuthConfig added in v1.13.0

type ClientAuthConfig struct {
	Username string `alloy:"username,attr"`
	Password string `alloy:"password,attr"`
}

type HtpasswdConfig added in v1.13.0

type HtpasswdConfig struct {
	File   string `alloy:"file,attr,optional"`
	Inline string `alloy:"inline,attr,optional"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL