oauth2

Documentation

Index

• type Arguments
  • func (args Arguments) AuthFeatures() auth.AuthFeature
  • func (args Arguments) ConvertClient() (otelcomponent.Config, error)
  • func (args Arguments) ConvertServer() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
  • func (args *Arguments) SetToDefault()

Types

type Arguments

type Arguments struct {
	ClientID         string                     `alloy:"client_id,attr,optional"`
	ClientIDFile     string                     `alloy:"client_id_file,attr,optional"`
	ClientSecret     alloytypes.Secret          `alloy:"client_secret,attr,optional"`
	ClientSecretFile string                     `alloy:"client_secret_file,attr,optional"`
	TokenURL         string                     `alloy:"token_url,attr"`
	EndpointParams   url.Values                 `alloy:"endpoint_params,attr,optional"`
	Scopes           []string                   `alloy:"scopes,attr,optional"`
	TLSSetting       otelcol.TLSClientArguments `alloy:"tls,block,optional"`
	Timeout          time.Duration              `alloy:"timeout,attr,optional"`
	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`
}

Arguments configures the otelcol.auth.oauth2 component.

func (Arguments) AuthFeatures

func (args Arguments) AuthFeatures() auth.AuthFeature

AuthFeatures implements auth.Arguments.

func (Arguments) ConvertClient

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

ConvertClient implements auth.Arguments.

func (Arguments) ConvertServer

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

ConvertServer returns nil since the ouath2 client extension does not support server auth.

func (Arguments) DebugMetricsConfig

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]otelextension.Extension

Extensions implements auth.Arguments.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.