[#BloombergLP-balm-MetricsManager-publish-028]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/MetricsManager.adoc[MetricsManager]::publish
:relfileprefix: ../../../
:mrdocs:

`publish` overloads

== Synopses

Declared in `<balm_metricsmanager.h>`

Publish metrics belonging to the specified `categories`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balm/MetricsManager/publish-02e.adoc[publish](
    xref:bsl/set-0d.adoc[bsl::set<Category const*>] const& categories,
    bool resetFlag = true);
----

[.small]#xref:BloombergLP/balm/MetricsManager/publish-02e.adoc[_» more..._]#

Same as the preceding overload, using a `std::pmr::set` of categories.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balm/MetricsManager/publish-08.adoc[publish](
    std::pmr::set<Category const*> const& categories,
    bool resetFlag = true);
----

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

Same as the preceding overload, using a `std::set` of categories.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balm/MetricsManager/publish-020.adoc[publish](
    std::set<Category const*> const& categories,
    bool resetFlag = true);
----

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

Publish metrics associated with the specified `category` if `category` is enabled; otherwise (if `category` is not enabled) this method has no effect. Optionally specify a `resetFlag` that determines if the collected metrics are reset as part of this operation. If `category` is enabled (i.e., `category‐>isEnabled()` is `true`), this operation will collect aggregated metric values for `category` from any registered callbacks as well as from its own `CollectorRepository`, and then publish those records using any publishers associated with `category`. If `resetFlag` is `true`, the metrics being collected are reset to their default state. The metrics manager provides publishers the time interval over which the published metrics were collected. This interval is computed as the elapsed time since the last time the `category` was reset (either through a call to the `publish` or `collectSample` methods). If `category` has not previously been reset then this interval is taken to be the elapsed time since the creation of this metrics manager. Note that the alternative `publish` methods that publish multiple categories in a single invocation are more efficient than publishing a sequence of categories individually.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balm/MetricsManager/publish-03a.adoc[publish](
    xref:BloombergLP/balm/Category.adoc[Category] const* category,
    bool resetFlag = true);
----

[.small]#xref:BloombergLP/balm/MetricsManager/publish-03a.adoc[_» more..._]#

Publish metrics belonging to the specified sequence of (unique) `categories`, of specified length `numCategories`. Optionally specify a `resetFlag` that determines if the collected metrics are reset as part of this operation. This operation will collect aggregated metric values for each _enabled_ category in `categories` from registered callbacks as well as from its own `CollectorRepository`, and then publish those records using any publishers associated with the category. Any individual category in `categories` that is not enabled is ignored. If `resetFlag` is `true`, the metrics being collected are reset to their default state. The metrics manager provides publishers the time interval over which the published metrics were collected. This interval is computed as the elapsed time since the last time the `category` was reset (either through a call to the `publish` or `collectSample` methods). If a category has not previously been reset then this interval is taken to be the elapsed time since the creation of this metrics manager. The behavior is undefined unless `0 <= numCategories`, `categories` refers to a contiguous sequence of (at least) `numCategories`, and each category in `categories` appears only once.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balm/MetricsManager/publish-03e.adoc[publish](
    xref:BloombergLP/balm/Category.adoc[Category] const const* categories[],
    int numCategories,
    bool resetFlag = true);
----

[.small]#xref:BloombergLP/balm/MetricsManager/publish-03e.adoc[_» more..._]#


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