promrelabel

Documentation

Index

• func CleanLabels(labels []prompbmarshal.Label)
• func FinalizeLabels(dst, src []prompbmarshal.Label) []prompbmarshal.Label
• func GetLabelByName(labels []prompbmarshal.Label, name string) *prompbmarshal.Label
• func GetLabelValueByName(labels []prompbmarshal.Label, name string) string
• func RemoveMetaLabels(dst, src []prompbmarshal.Label) []prompbmarshal.Label
• func SortLabels(labels []prompbmarshal.Label)
• func SortLabelsStable(labels []prompbmarshal.Label)
• type IfExpression
  • func (ie *IfExpression) MarshalJSON() ([]byte, error)
  • func (ie *IfExpression) MarshalYAML() (interface{}, error)
  • func (ie *IfExpression) Match(labels []prompbmarshal.Label) bool
  • func (ie *IfExpression) Parse(s string) error
  • func (ie *IfExpression) String() string
  • func (ie *IfExpression) UnmarshalJSON(data []byte) error
  • func (ie *IfExpression) UnmarshalYAML(f func(interface{}) error) error
• type MultiLineRegex
  • func (mlr *MultiLineRegex) MarshalYAML() (interface{}, error)
  • func (mlr *MultiLineRegex) UnmarshalYAML(f func(interface{}) error) error
• type ParsedConfigs
  • func LoadRelabelConfigs(path string, relabelDebug bool) (*ParsedConfigs, error)
  • func ParseRelabelConfigs(rcs []RelabelConfig, relabelDebug bool) (*ParsedConfigs, error)
  • func ParseRelabelConfigsData(data []byte, relabelDebug bool) (*ParsedConfigs, error)
  • func (pcs *ParsedConfigs) Apply(labels []prompbmarshal.Label, labelsOffset int, isFinalize bool) []prompbmarshal.Label
  • func (pcs *ParsedConfigs) Len() int
  • func (pcs *ParsedConfigs) String() string
• type RelabelConfig

Functions

func CleanLabels

func CleanLabels(labels []prompbmarshal.Label)

CleanLabels sets label.Name and label.Value to an empty string for all the labels.

This should help GC cleaning up label.Name and label.Value strings.

func FinalizeLabels

func FinalizeLabels(dst, src []prompbmarshal.Label) []prompbmarshal.Label

FinalizeLabels removes labels with "__" in the beginning (except of "__name__").

func GetLabelByName

func GetLabelByName(labels []prompbmarshal.Label, name string) *prompbmarshal.Label

GetLabelByName returns label with the given name from labels.

func GetLabelValueByName

func GetLabelValueByName(labels []prompbmarshal.Label, name string) string

GetLabelValueByName returns value for label with the given name from labels.

It returns empty string for non-existing label.

func RemoveMetaLabels

func RemoveMetaLabels(dst, src []prompbmarshal.Label) []prompbmarshal.Label

RemoveMetaLabels removes all the `__meta_` labels from src and puts the rest of labels to dst.

See https://www.robustperception.io/life-of-a-label fo details.

func SortLabels

func SortLabels(labels []prompbmarshal.Label)

SortLabels sorts labels.

func SortLabelsStable

func SortLabelsStable(labels []prompbmarshal.Label)

SortLabelsStable sorts labels using stable sort.

Types

type IfExpression

type IfExpression struct {
	// contains filtered or unexported fields
}

IfExpression represents `if` expression at RelabelConfig.

The `if` expression can contain arbitrary PromQL-like label filters such as `metric_name{filters...}`

func (*IfExpression) MarshalJSON

func (ie *IfExpression) MarshalJSON() ([]byte, error)

MarshalJSON marshals ie to JSON.

func (*IfExpression) MarshalYAML

func (ie *IfExpression) MarshalYAML() (interface{}, error)

MarshalYAML marshals ie to YAML.

func (*IfExpression) Match

func (ie *IfExpression) Match(labels []prompbmarshal.Label) bool

Match returns true if ie matches the given labels.

func (*IfExpression) Parse

func (ie *IfExpression) Parse(s string) error

Parse parses `if` expression from s and stores it to ie.

func (*IfExpression) String

func (ie *IfExpression) String() string

String returns string representation of ie.

func (*IfExpression) UnmarshalJSON

func (ie *IfExpression) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals ie from JSON data.

func (*IfExpression) UnmarshalYAML

func (ie *IfExpression) UnmarshalYAML(f func(interface{}) error) error

UnmarshalYAML unmarshals ie from YAML passed to f.

type MultiLineRegex

type MultiLineRegex struct {
	S string
}

MultiLineRegex contains a regex, which can be split into multiple lines.

These lines are joined with "|" then. For example:

regex: - foo - bar

is equivalent to:

regex: "foo|bar"

func (*MultiLineRegex) MarshalYAML

func (mlr *MultiLineRegex) MarshalYAML() (interface{}, error)

MarshalYAML marshals mlr to YAML.

func (*MultiLineRegex) UnmarshalYAML

func (mlr *MultiLineRegex) UnmarshalYAML(f func(interface{}) error) error

UnmarshalYAML unmarshals mlr from YAML passed to f.

type ParsedConfigs

type ParsedConfigs struct {
	// contains filtered or unexported fields
}

ParsedConfigs represents parsed relabel configs.

func LoadRelabelConfigs

func LoadRelabelConfigs(path string, relabelDebug bool) (*ParsedConfigs, error)

LoadRelabelConfigs loads relabel configs from the given path.

func ParseRelabelConfigs

func ParseRelabelConfigs(rcs []RelabelConfig, relabelDebug bool) (*ParsedConfigs, error)

ParseRelabelConfigs parses rcs to dst.

func ParseRelabelConfigsData

func ParseRelabelConfigsData(data []byte, relabelDebug bool) (*ParsedConfigs, error)

ParseRelabelConfigsData parses relabel configs from the given data.

func (*ParsedConfigs) Apply

func (pcs *ParsedConfigs) Apply(labels []prompbmarshal.Label, labelsOffset int, isFinalize bool) []prompbmarshal.Label

Apply applies pcs to labels starting from the labelsOffset.

If isFinalize is set, then FinalizeLabels is called on the labels[labelsOffset:].

The returned labels at labels[labelsOffset:] are sorted.

func (*ParsedConfigs) Len

func (pcs *ParsedConfigs) Len() int

Len returns the number of relabel configs in pcs.

func (*ParsedConfigs) String

func (pcs *ParsedConfigs) String() string

String returns human-readabale representation for pcs.

type RelabelConfig

type RelabelConfig struct {
	SourceLabels []string        `yaml:"source_labels,flow,omitempty"`
	Separator    *string         `yaml:"separator,omitempty"`
	TargetLabel  string          `yaml:"target_label,omitempty"`
	Regex        *MultiLineRegex `yaml:"regex,omitempty"`
	Modulus      uint64          `yaml:"modulus,omitempty"`
	Replacement  *string         `yaml:"replacement,omitempty"`
	Action       string          `yaml:"action,omitempty"`
	If           *IfExpression   `yaml:"if,omitempty"`

	// Match is used together with Labels for `action: graphite`. For example:
	// - action: graphite
	//   match: 'foo.*.*.bar'
	//   labels:
	//     job: '$1'
	//     instance: '${2}:8080'
	Match string `yaml:"match,omitempty"`

	// Labels is used together with Match for `action: graphite`. For example:
	// - action: graphite
	//   match: 'foo.*.*.bar'
	//   labels:
	//     job: '$1'
	//     instance: '${2}:8080'
	Labels map[string]string `yaml:"labels,omitempty"`
}

RelabelConfig represents relabel config.

See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config