relabel

Documentation

Index

• Variables
• func ComponentToPromRelabelConfigs(rcs []*Config) []*relabel.Config
• type Action
  • func (a Action) MarshalText() (text []byte, err error)
  • func (a Action) String() string
  • func (a *Action) UnmarshalText(text []byte) error
• type Config
  • func (c *Config) SetToDefault()
  • func (rc *Config) Validate() error
• type Regexp
  • func (re Regexp) MarshalText() (text []byte, err error)
  • func (re Regexp) String() string
  • func (re *Regexp) UnmarshalText(text []byte) error
• type Rules
  • func (r Rules) RiverCapsule()

Variables

var DefaultRelabelConfig = Config{
	Action:      Replace,
	Separator:   ";",
	Regex:       mustNewRegexp("(.*)"),
	Replacement: "$1",
}

DefaultRelabelConfig sets the default values of fields when decoding a RelabelConfig block.

Functions

func ComponentToPromRelabelConfigs

func ComponentToPromRelabelConfigs(rcs []*Config) []*relabel.Config

ComponentToPromRelabelConfigs bridges the Component-based configuration of relabeling steps to the Prometheus implementation.

Types

type Action

type Action string

Action is the relabelling action to be performed.

const (
	Replace   Action = "replace"
	Keep      Action = "keep"
	Drop      Action = "drop"
	HashMod   Action = "hashmod"
	LabelMap  Action = "labelmap"
	LabelDrop Action = "labeldrop"
	LabelKeep Action = "labelkeep"
	Lowercase Action = "lowercase"
	Uppercase Action = "uppercase"
	KeepEqual Action = "keepequal"
	DropEqual Action = "dropequal"
)

All possible Action values.

func (Action) MarshalText

func (a Action) MarshalText() (text []byte, err error)

MarshalText implements encoding.TextMarshaler for Action.

func (Action) String

func (a Action) String() string

String returns the string representation of the Action type.

func (*Action) UnmarshalText

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

UnmarshalText implements encoding.TextUnmarshaler for Action.

type Config

type Config struct {
	SourceLabels []string `river:"source_labels,attr,optional"`
	Separator    string   `river:"separator,attr,optional"`
	Regex        Regexp   `river:"regex,attr,optional"`
	Modulus      uint64   `river:"modulus,attr,optional"`
	TargetLabel  string   `river:"target_label,attr,optional"`
	Replacement  string   `river:"replacement,attr,optional"`
	Action       Action   `river:"action,attr,optional"`
}

Config describes a relabelling step to be applied on a target.

func (*Config) SetToDefault

func (c *Config) SetToDefault()

SetToDefault implements river.Defaulter.

func (*Config) Validate

func (rc *Config) Validate() error

Validate implements river.Validator.

type Regexp

type Regexp struct {
	*regexp.Regexp
}

Regexp encapsulates the Regexp type from Grafana's fork of the Go stdlib regexp package.

func (Regexp) MarshalText

func (re Regexp) MarshalText() (text []byte, err error)

MarshalText implements encoding.TextMarshaler for Regexp.

func (Regexp) String

func (re Regexp) String() string

String returns the original string used to compile the regular expression.

func (*Regexp) UnmarshalText

func (re *Regexp) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler for Regexp.

type Rules

type Rules []*Config

Rules returns the relabel configs in use for a relabeling component.

func (Rules) RiverCapsule

func (r Rules) RiverCapsule()

RiverCapsule marks the alias defined above as a "capsule type" so that it cannot be invoked by River code.