This class provides a mechanism for collecting and aggregating the value of a metric over a period of time.
Declared in <balm_collector.h>
class Collector;The collector contains a MetricRecord object that holds the identity of the metric being collected, the number of times an event occurred, and the total, minimum, and maximum aggregates of the associated measurement value. The default value for the count is 0, the default value for the total is 0.0, the default minimum value is MetricRecord::k_DEFAULT_MIN, and the default maximum value is MetricRecord::k_DEFAULT_MAX.
| Name | Description |
|---|---|
Collector [constructor] | Create a collector for a metric having the specified metricId. |
~Collector [destructor] | Destroy this object. |
accumulateCountTotalMinMax | Accumulate the specified count, total, min, and max into this collector. |
load | Load into the specified record the id of the metric being collected, as well as the current count, total, minimum, and maximum aggregated values for the metric. |
loadAndReset | Load the current metric aggregates into the specified record and reset this collector. |
metricId | Return a reference to the non-modifiable MetricId object identifying the metric for which this object collects values. |
reset | Reset the count, total, minimum, and maximum values of the metric being collected to their default states. |
setCountTotalMinMax | Set the count, total, min, and max aggregates to the specified values. |
update | Update the collected aggregates with the specified value. |