decorate

Documentation

Index

• type Chain
  • func (c Chain) Decorate(mfs []*dto.MetricFamily)
  • func (c Chain) Name() string
• type Decorator
• type LabelAppender
  • func (l LabelAppender) Decorate(mfs []*dto.MetricFamily)
  • func (LabelAppender) Name() string
• type LowercaseNames
  • func (LowercaseNames) Decorate(mfs []*dto.MetricFamily)
  • func (LowercaseNames) Name() string
• type TopK
  • func (t TopK) Decorate(mfs []*dto.MetricFamily)
  • func (t TopK) Name() string

Types

type Chain

type Chain []Decorator

Chain of decorators to be applied to the metric family

func (Chain) Decorate

func (c Chain) Decorate(mfs []*dto.MetricFamily)

Decorate the metric family

func (Chain) Name

func (c Chain) Name() string

Name is the name of the decorator

type Decorator

type Decorator interface {
	Decorate([]*dto.MetricFamily)
	Name() string
}

Decorator decorates a list of metric families

type LabelAppender

type LabelAppender []*dto.LabelPair

LabelAppender is a list of label pairs that need to be added on all metrics

func (LabelAppender) Decorate

func (l LabelAppender) Decorate(mfs []*dto.MetricFamily)

Decorate adds metric labels from its list

func (LabelAppender) Name

func (LabelAppender) Name() string

Name is the name of this decorator

type LowercaseNames

type LowercaseNames struct{}

LowercaseNames decorates metrics to be have all lowercase label names

func (LowercaseNames) Decorate

func (LowercaseNames) Decorate(mfs []*dto.MetricFamily)

Decorate decorates the provided metrics for compatibility

func (LowercaseNames) Name

func (LowercaseNames) Name() string

Name is the name of this decorator

type TopK

type TopK struct {
	K uint
	N string
}

TopK is a decorator that removes metrics not in the top K by value

func (TopK) Decorate

func (t TopK) Decorate(mfs []*dto.MetricFamily)

Decorate removes all but the top K metrics for a given metric name

func (TopK) Name

func (t TopK) Name() string

Name is the name of this decorator