Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class Exemplar

java.lang.Object

io.prometheus.metrics.model.snapshots.Exemplar

public class Exemplar
extends Object

Immutable representation of an Exemplar.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Exemplar.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SPAN_ID	Label name for span id.
static final String	TRACE_ID	Label name for trace id.

Constructor Summary

Constructors

Constructor	Description
Exemplar(double value, Labels labels, long timestampMillis)	To create a new Exemplar, you can either call the constructor directly or use the Builder with builder().

Method Summary

Modifier and Type	Method	Description
static Exemplar.Builder	builder()
Labels	getLabels()	In most cases labels will contain TRACE_ID and SPAN_ID, but this is not required.
long	getTimestampMillis()	Will return garbage if hasTimestamp() is false.
double	getValue()
boolean	hasTimestamp()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TRACE_ID

public static final String TRACE_ID

Label name for trace id.

See Also:

• Constant Field Values

SPAN_ID

public static final String SPAN_ID

Label name for span id.

See Also:

• Constant Field Values

Constructor Details

Exemplar

public Exemplar(double value,
 Labels labels,
 long timestampMillis)

To create a new Exemplar, you can either call the constructor directly or use the Builder with builder().

Parameters:

value - the observed value. This is required.

labels - in most cases the labels will contain the TRACE_ID and SPAN_ID. Must not be null. Use Labels.EMPTY if no labels are present.

timestampMillis - timestamp when the value was observed. Optional. Use 0L if not available.

Method Details

getValue

public double getValue()

getLabels

public Labels getLabels()

In most cases labels will contain TRACE_ID and SPAN_ID, but this is not required. May be Labels.EMPTY, but may not be null.

hasTimestamp

public boolean hasTimestamp()

getTimestampMillis

public long getTimestampMillis()

Will return garbage if hasTimestamp() is false.

builder

public static Exemplar.Builder builder()