BloombergLP::balm::Metric_MacroImp::getCollector

Load the default collector for a metric, register a holder, and set publication type.

Synopsis

Declared in <balm_metric.h>

static
void
getCollector(
    Collector** collector,
    CategoryHolder* holder,
    char const* category,
    char const* metric,
    PublicationType::Value preferredPublicationType);

Description

Load the specified collector with the address of the default collector (from the default metrics manager) for the specified metric identified by the specified category and name, register the specified holder for category, and set the identified metric's preferred publication type to the specified preferredPublicationType. Note that *collector must be assigned before holder to ensure that the macros always have a valid collector when holder->enabled() is true.

Parameters

NameDescription
collectorreceives the address of the default collector
holdercategory holder to register for category
categorynull-terminated category name
metricnull-terminated metric name
preferredPublicationTypepreferred publication type for the metric