BloombergLP::balm::ConfigurationUtil::setFormat

Set the format for the metric identified by category and metricName to format.

Synopsis

Declared in <balm_configurationutil.h>

static
int
setFormat(
    char const* category,
    char const* metricName,
    MetricFormat const& format,
    MetricsManager* manager = 0);

Description

Optionally specify a metrics manager to configure. If manager is 0, configure the default metrics manager; if manager is 0 and the default metrics manager has not been initialized, this method has no effect. Return 0 on success, or a non-zero value if manager is 0 and the default metrics manager has not been initialized. If a MetricId does not exist for category and metricName, create one and add it to the metric registry of the indicated metrics manager.

Return Value

0 on success, or a non-zero value if manager is 0 and the default metrics manager has not been initialized

Parameters

NameDescription
categorycategory of the metric to format
metricNamename of the metric to format
formatformat specification to apply
managermetrics manager to configure; 0 uses the default