headers

package
v1.3.3 Latest Latest
Warning

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

Go to latest
Published: Sep 25, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package headers provides an otelcol.auth.headers component.

Index

Constants

This section is empty.

Variables

View Source
var DefaultHeader = Header{
	Action: ActionUpsert,
}

Functions

This section is empty.

Types

type Action

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

func (*Action) Convert

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 added in v1.2.0

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements auth.Arguments.

func (Arguments) Exporters

Exporters implements auth.Arguments.

func (Arguments) Extensions

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

Extensions implements auth.Arguments.

func (*Arguments) SetToDefault added in v1.2.0

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

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.

Jump to

Keyboard shortcuts

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