headers

package

v1.1.0 Latest Latest Go to latest Published: May 14, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/grafana/alloy

Links

Open Source Insights

Documentation ¶

Overview ¶

Package headers provides an otelcol.auth.headers component.

Index ¶

Variables
type Action
type Arguments
type Header
- func (h *Header) SetToDefault()
- func (h *Header) Validate() error

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 ¶

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"`
}

Arguments configures the otelcol.auth.headers component.

func (Arguments) Convert ¶

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

Convert 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.

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 (h *Header) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (h *Header) Validate() error