Class NBMetricHistogram

java.lang.Object

com.codahale.metrics.Histogram

io.nosqlbench.nb.api.engine.metrics.instruments.NBMetricHistogram

All Implemented Interfaces:

com.codahale.metrics.Counting, com.codahale.metrics.Metric, com.codahale.metrics.Sampling, DeltaSnapshotter, HdrDeltaHistogramAttachment, HdrDeltaHistogramProvider, HistogramAttachment, NBMetric, NBLabeledElement

public class NBMetricHistogram
extends com.codahale.metrics.Histogram
implements DeltaSnapshotter, HdrDeltaHistogramAttachment, HistogramAttachment, NBMetric

Nested Class Summary

Nested classes/interfaces inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

NBLabeledElement.BasicLabeledElement

Field Summary

Fields inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

EMPTY

Constructor Summary

Constructors

Constructor	Description
NBMetricHistogram(NBLabels labels, DeltaHdrHistogramReservoir hdrHistogramReservoir, String description, MetricCategory... categories)
NBMetricHistogram(String name, DeltaHdrHistogramReservoir hdrHistogramReservoir, String description, MetricCategory... categories)

Method Summary

Modifier and Type	Method	Description
NBMetricHistogram	attachHdrDeltaHistogram()	Attach a metric.
com.codahale.metrics.Histogram	attachHistogram(com.codahale.metrics.Histogram histogram)
MetricCategory[]	getCategories()
DeltaSnapshotReader	getDeltaReader()
ConvenientSnapshot	getDeltaSnapshot(long cacheTimeMillis)
String	getDescription()
NBLabels	getLabels()
org.HdrHistogram.Histogram	getNextHdrDeltaHistogram()	Create a new interval histogram from the current data, then reset the histogram reservoir.
ConvenientSnapshot	getSnapshot()	Only return a new snapshot form current reservoir data if the cached one has expired.
String	toString()
String	typeName()
void	update(long value)

Methods inherited from class com.codahale.metrics.Histogram

getCount, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

description

Methods inherited from interface io.nosqlbench.nb.api.engine.metrics.instruments.NBMetric

getHandle

Constructor Details

NBMetricHistogram

public NBMetricHistogram(NBLabels labels,
 DeltaHdrHistogramReservoir hdrHistogramReservoir,
 String description,
 MetricCategory... categories)

NBMetricHistogram

public NBMetricHistogram(String name,
 DeltaHdrHistogramReservoir hdrHistogramReservoir,
 String description,
 MetricCategory... categories)

Method Details

getDeltaReader

public DeltaSnapshotReader getDeltaReader()

Specified by:

getDeltaReader in interface DeltaSnapshotter

getSnapshot

public ConvenientSnapshot getSnapshot()

Only return a new snapshot form current reservoir data if the cached one has expired.

Specified by:

getSnapshot in interface com.codahale.metrics.Sampling

Overrides:

getSnapshot in class com.codahale.metrics.Histogram

Returns:

a new delta snapshot, or the cached one

getDeltaSnapshot

public ConvenientSnapshot getDeltaSnapshot(long cacheTimeMillis)

Specified by:

getDeltaSnapshot in interface DeltaSnapshotter

attachHdrDeltaHistogram

public NBMetricHistogram attachHdrDeltaHistogram()

Description copied from interface: HdrDeltaHistogramAttachment

Attach a metric.

Specified by:

attachHdrDeltaHistogram in interface HdrDeltaHistogramAttachment

Returns:

the attached metric, after adding to the mirrors for the metric.

attachHistogram

public com.codahale.metrics.Histogram attachHistogram(com.codahale.metrics.Histogram histogram)

Specified by:

attachHistogram in interface HistogramAttachment

update

public void update(long value)

Overrides:

update in class com.codahale.metrics.Histogram

getNextHdrDeltaHistogram

public org.HdrHistogram.Histogram getNextHdrDeltaHistogram()

Description copied from interface: HdrDeltaHistogramProvider

Create a new interval histogram from the current data, then reset the histogram reservoir.

Specified by:

getNextHdrDeltaHistogram in interface HdrDeltaHistogramProvider

Returns:

the new interval histogram

getLabels

public NBLabels getLabels()

Specified by:

getLabels in interface NBLabeledElement

typeName

public String typeName()

Specified by:

typeName in interface NBMetric

getDescription

public String getDescription()

Specified by:

getDescription in interface NBMetric

getCategories

public MetricCategory[] getCategories()

Specified by:

getCategories in interface NBMetric

toString

public String toString()

Overrides:

toString in class Object