Class NBVariableGauge

java.lang.Object

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

All Implemented Interfaces:

com.codahale.metrics.Gauge<Double>, com.codahale.metrics.Metric, NBMetric, NBMetricGauge, NBLabeledElement

public class NBVariableGauge
extends Object
implements NBMetricGauge

Use this gauge type when you are setting the gauge value directly. It is merely a holder for the measurement which is injected at the discretion of the scenario.

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
NBVariableGauge(NBComponent parent, String metricFamilyName, double initialValue, NBLabels additionalLabels, String description, MetricCategory... categories)

Method Summary

Modifier and Type	Method	Description
MetricCategory[]	getCategories()
String	getDescription()
NBLabels	getLabels()
Double	getValue()
String	typeName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

NBVariableGauge

public NBVariableGauge(NBComponent parent,
 String metricFamilyName,
 double initialValue,
 NBLabels additionalLabels,
 String description,
 MetricCategory... categories)

Method Details

getLabels

public NBLabels getLabels()

Specified by:

getLabels in interface NBLabeledElement

getValue

public Double getValue()

Specified by:

getValue in interface com.codahale.metrics.Gauge<Double>

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