Package org.opennms.nephron.cortex

Interface TimeSeriesBuilder

public interface TimeSeriesBuilder

Allows to add labels and samples to an underlying protobuf builder.

The metric name is just a special kind of label. Therefore setMetricName(String) should be called only once.

Label names and metric names are sanitized according to Cortex requirements.

Method Summary

Modifier and Type	Method	Description
default TimeSeriesBuilder	addLabel(String name, int value)
default TimeSeriesBuilder	addLabel(String name, Integer value)
TimeSeriesBuilder	addLabel(String name, String value)
TimeSeriesBuilder	addSample(long epochMillis, double value)
TimeSeriesBuilder	nextSeries()	Starts another time series.
TimeSeriesBuilder	setMetricName(String name)

Method Detail

setMetricName

TimeSeriesBuilder setMetricName(String name)

addLabel

TimeSeriesBuilder addLabel(String name,
                           String value)

addSample

TimeSeriesBuilder addSample(long epochMillis,
                            double value)

nextSeries

TimeSeriesBuilder nextSeries()

Starts another time series.

Clients of a time series builder may need to output samples for different time series. In that case nextSeries must be called in-between.

addLabel

default TimeSeriesBuilder addLabel(String name,
                                   int value)

addLabel

default TimeSeriesBuilder addLabel(String name,
                                   Integer value)