headers

Documentation

Overview

Package headers provides an otelcol.auth.headers component.

Index

• Variables
• type Action
  • func (a *Action) Convert(hc *headerssetterextension.HeaderConfig) error
  • func (a *Action) UnmarshalText(text []byte) error
  • func (a *Action) Validate() error
• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
  • func (args *Arguments) SetToDefault()
• type Header
  • func (h *Header) SetToDefault()
  • func (h *Header) Validate() error

Variables

var DefaultHeader = Header{
	Action: ActionUpsert,
}

Types

type Action

type Action string

const (
	ActionInsert Action = "insert"
	ActionUpdate Action = "update"
	ActionUpsert Action = "upsert"
	ActionDelete Action = "delete"
)

func (*Action) Convert

func (a *Action) Convert(hc *headerssetterextension.HeaderConfig) error

Convert the Alloy type to the Otel type. TODO: When headerssetterextension.actionValue is made external, remove the input parameter and make this output the Otel type.

func (*Action) UnmarshalText

func (a *Action) UnmarshalText(text []byte) error

func (*Action) Validate

func (a *Action) Validate() error

Validate implements syntax.Validator.

type Arguments

type Arguments struct {
	Headers []Header `alloy:"header,block,optional"`

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

Arguments configures the otelcol.auth.headers component.

func (Arguments) Convert

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

Convert implements auth.Arguments.

func (Arguments) DebugMetricsConfig

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements auth.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[otelcomponent.DataType]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.

type Header

type Header struct {
	Key         string                     `alloy:"key,attr"`
	Value       *alloytypes.OptionalSecret `alloy:"value,attr,optional"`
	FromContext *string                    `alloy:"from_context,attr,optional"`
	Action      Action                     `alloy:"action,attr,optional"`
}

Header is an individual Header to send along with requests.

func (*Header) SetToDefault

func (h *Header) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (*Header) Validate

func (h *Header) Validate() error

Validate implements syntax.Validator.