io.opencensus.metrics.export

Class Distribution.Exemplar

java.lang.Object

io.opencensus.metrics.export.Distribution.Exemplar

Enclosing class:

Distribution

@Immutable
public abstract static class Distribution.Exemplar
extends Object

An example point that may be used to annotate aggregated distribution values, associated with a histogram bucket.

Since:

0.17

Method Summary

Modifier and Type	Method and Description
static Distribution.Exemplar	create(double value, Timestamp timestamp, Map<String,String> attachments) Creates an Distribution.Exemplar.
abstract Map<String,String>	getAttachments() Returns the contextual information about the example value, represented as a string map.
abstract Timestamp	getTimestamp() Returns the time that this Distribution.Exemplar's value was recorded.
abstract double	getValue() Returns value of the Distribution.Exemplar point.

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public abstract double getValue()

Returns value of the Distribution.Exemplar point.

Returns:

value of the Exemplar point.

Since:

0.17

getTimestamp

public abstract Timestamp getTimestamp()

Returns the time that this Distribution.Exemplar's value was recorded.

Returns:

the time that this Exemplar's value was recorded.

Since:

0.17

getAttachments

public abstract Map<String,String> getAttachments()

Returns the contextual information about the example value, represented as a string map.

Returns:

the contextual information about the example value.

Since:

0.17

create

public static Distribution.Exemplar create(double value,
                                           Timestamp timestamp,
                                           Map<String,String> attachments)

Creates an Distribution.Exemplar.

Parameters:

value - value of the Distribution.Exemplar point.

timestamp - the time that this Exemplar's value was recorded.

attachments - the contextual information about the example value.

Returns:

an Exemplar.

Since:

0.17