[#BloombergLP-balm-Metric_MacroImp-getCollector-07]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/Metric_MacroImp.adoc[Metric_MacroImp]::getCollector
:relfileprefix: ../../../
:mrdocs:

Load the default collector for a metric and register a category holder.

== Synopsis

Declared in `<balm_metric.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
void
getCollector(
    xref:BloombergLP/balm/Collector.adoc[Collector]** collector,
    xref:BloombergLP/balm/CategoryHolder.adoc[CategoryHolder]* holder,
    char const* category,
    char const* metric);
----

== 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`, and register the specified `holder` for `category`. Note that `*collector` must be assigned _before_ registering `holder` to ensure that the macros always have a valid `collector` when `holder‐>enabled()` is `true`.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *collector*
| receives the address of the default collector
| *holder*
| category holder to register for `category`
| *category*
| null‐terminated category name
| *metric*
| null‐terminated metric name
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#