prompb

package
v0.4.1 Latest Latest
Warning

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

Go to latest
Published: Nov 12, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	WriteRequestPool = NewPool(
		func() *WriteRequest {
			return &WriteRequest{}
		},
	)

	TimeSeriesPool = NewPool(
		func() *TimeSeries {
			return &TimeSeries{}
		},
	)
)

Functions

func CompareLower

func CompareLower(sa, sb []byte) int

func IsSorted

func IsSorted(l []*Label) bool

IsSorted return true if the labels are sorted according to Sort.

func MergedLabels added in v0.4.0

func MergedLabels(seriesLabels, commonLabels []*Label) iter.Seq[*Label]

MergedLabels returns an iterator over the sorted merge of seriesLabels and commonLabels without materializing the merged slice. If both inputs contain the same label name, the per-series label takes precedence.

Both input slices must be sorted according to Sort and must not be modified while the iterator is running.

func MetricName

func MetricName(ts *TimeSeries) []byte

func Sort

func Sort(l []*Label)

Sort sorts labels ensuring the __name__ is first the remaining labels or ordered by name.

Types

type Iterator

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

func NewIterator

func NewIterator(r io.ReadCloser) *Iterator

func (*Iterator) Close

func (i *Iterator) Close() error

func (*Iterator) Err

func (i *Iterator) Err() error

func (*Iterator) Next

func (i *Iterator) Next() bool

func (*Iterator) ParseTimeSeriesInto

func (i *Iterator) ParseTimeSeriesInto(ts *TimeSeries, line string) (*TimeSeries, error)

func (*Iterator) Reset

func (i *Iterator) Reset(r io.ReadCloser)

func (*Iterator) TimeSeriesInto

func (i *Iterator) TimeSeriesInto(ts *TimeSeries) (*TimeSeries, error)

func (*Iterator) Value

func (i *Iterator) Value() string

type Label

type Label struct {
	Name  []byte
	Value []byte
}

Label is a timeseries label

func (*Label) Reset

func (l *Label) Reset()

type LabelDropRule added in v0.4.0

type LabelDropRule struct {
	Metric *regexp.Regexp
	Label  *regexp.Regexp
}

LabelDropRule drops matching label names from matching metrics.

type LabelFilter added in v0.4.0

type LabelFilter struct {
	Drop []LabelDropRule
	Keep [][]byte
}

LabelFilter contains immutable request-level label filtering rules.

func (*LabelFilter) Drops added in v0.4.0

func (f *LabelFilter) Drops(metricName, name []byte) bool

Drops reports whether name is excluded for metricName. The metric name label is always retained, and explicit keep entries take precedence.

type Labels

type Labels []Label

func (Labels) Len

func (l Labels) Len() int

func (Labels) Less

func (l Labels) Less(i, j int) bool

func (Labels) Swap

func (l Labels) Swap(i, j int)

type Pool

type Pool[T Resetter] struct {
	New func() T
	// contains filtered or unexported fields
}

func NewPool

func NewPool[T Resetter](new func() T) *Pool[T]

func (*Pool[T]) Get

func (p *Pool[T]) Get() T

func (*Pool[T]) Put

func (p *Pool[T]) Put(r T)

type Resetter

type Resetter interface {
	Reset()
}

type Sample

type Sample struct {
	Value     float64
	Timestamp int64
}

Sample is a timeseries sample.

func (*Sample) Reset

func (s *Sample) Reset()

type TimeSeries

type TimeSeries struct {
	Labels  []*Label
	Samples []*Sample
}

TimeSeries is a timeseries.

func (*TimeSeries) AppendLabel

func (m *TimeSeries) AppendLabel(key []byte, value []byte)

func (*TimeSeries) AppendLabelString

func (m *TimeSeries) AppendLabelString(key string, value string)

func (*TimeSeries) AppendSample

func (m *TimeSeries) AppendSample(timestamp int64, value float64)

func (*TimeSeries) Reset

func (ts *TimeSeries) Reset()

type WriteRequest

type WriteRequest struct {
	Timeseries []*TimeSeries

	// CommonLabels is an immutable sorted set of labels shared by every time
	// series in this request. It is materialized into each series when the
	// request is marshaled to the Prometheus remote write protobuf format.
	CommonLabels []*Label

	// LabelFilter is an immutable set of request-level filtering rules applied
	// when consumers walk the effective labels for each time series.
	LabelFilter *LabelFilter
}

WriteRequest represents Prometheus remote write API request

func (*WriteRequest) Labels added in v0.4.0

func (wr *WriteRequest) Labels(series *TimeSeries) iter.Seq[*Label]

Labels returns the effective sorted labels for series, including common labels and request-level filtering. Per-series labels take precedence when both inputs contain the same name.

func (*WriteRequest) Marshal

func (wr *WriteRequest) Marshal() (dAtA []byte, err error)

func (*WriteRequest) MarshalTo

func (wr *WriteRequest) MarshalTo(dst []byte) ([]byte, error)

func (*WriteRequest) Reset

func (wr *WriteRequest) Reset()

Reset resets wr.

func (*WriteRequest) Unmarshal

func (wr *WriteRequest) Unmarshal(src []byte) (err error)

Unmarshal unmarshals m from src.

Jump to

Keyboard shortcuts

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