[#BloombergLP-balm-MetricsManager-collectSample-0c]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/MetricsManager.adoc[MetricsManager]::collectSample
:relfileprefix: ../../../
:mrdocs:

`collectSample` overloads

== Synopses

Declared in `<balm_metricsmanager.h>`

Collect a metric sample from the indicated categories into `sample`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balm/MetricsManager/collectSample-01.adoc[collectSample](
    xref:BloombergLP/balm/MetricSample.adoc[MetricSample]* sample,
    xref:bsl/vector-00d.adoc[bsl::vector<MetricRecord>]* records,
    bool resetFlag = false);
----

[.small]#xref:BloombergLP/balm/MetricsManager/collectSample-01.adoc[_» more..._]#

Same as the preceding overload, collecting from the specified `categories` sequence.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balm/MetricsManager/collectSample-06.adoc[collectSample](
    xref:BloombergLP/balm/MetricSample.adoc[MetricSample]* sample,
    xref:bsl/vector-00d.adoc[bsl::vector<MetricRecord>]* records,
    xref:BloombergLP/balm/Category.adoc[Category] const const* categories[],
    int numCategories,
    bool resetFlag = false);
----

[.small]#xref:BloombergLP/balm/MetricsManager/collectSample-06.adoc[_» more..._]#

== Parameters

[cols="1,4"]
|===
| Name| Description
| *sample*
| receives the collected metric sample
| *records*
| receives the metric records referred to by `sample`
| *resetFlag*
| if `true`, reset collected metrics to defaults
| *categories*
| sequence of unique categories to sample
| *numCategories*
| number of categories in `categories`
|===


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