BloombergLP::balm::StopwatchScopedGuard::StopwatchScopedGuard

Initialize this scoped guard to record an elapsed time to the metric identified by the specified category and name using the specified timeUnits.

Synopsis

Declared in <balm_stopwatchscopedguard.h>

StopwatchScopedGuard(
    char const* category,
    char const* name,
    Units timeUnits,
    MetricsManager* manager = 0);

Description

Optionally specify a metrics manager. If manager is 0, use the DefaultMetricsManager instance. If no manager is supplied, and the default instance has not been created, this object will be inactive (i.e., it will not record any values); similarly, if the identified category is disabled, then this object will be inactive. The behavior is undefined unless category and name are null-terminated. Note that timeUnits indicates the scale of the double value reported by this guard, but does not affect the precision of the elapsed time measurement.

Parameters

NameDescription
categorynull-terminated metric category name
namenull-terminated metric name
timeUnitsunits in which to report elapsed time
managermetrics manager used to provide the collector (optional)