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

Package namespace for metrics components&period;

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/BdlmMetricsAdapter.adoc[`BdlmMetricsAdapter`] 
| This class provides a concrete `bdlm&colon;&colon;MetricsAdapter` backed by `balm&colon;&colon;MetricsManager`&period;
| xref:BloombergLP/balm/Category.adoc[`Category`] 
| This class provides a mechanism for representing a category&period;
| xref:BloombergLP/balm/CategoryHolder.adoc[`CategoryHolder`] 
| This class holds a category, an enabled value, and a next&hyphen;holder pointer&period;
| xref:BloombergLP/balm/Collector.adoc[`Collector`] 
| This class provides a mechanism for collecting and aggregating the value of a metric over a period of time&period;
| xref:BloombergLP/balm/CollectorRepository.adoc[`CollectorRepository`] 
| This class defines a fully thread&hyphen;safe repository mechanism for `Collector` and `IntegerCollector` objects&period;
| xref:BloombergLP/balm/CollectorRepository_MetricCollectors.adoc[`CollectorRepository&lowbar;MetricCollectors`] 
| Private implementation type holding collectors for a single metric id&period;
| xref:BloombergLP/balm/ConfigurationUtil.adoc[`ConfigurationUtil`] 
| This `struct` provides utilities for configuring metrics&period;
| xref:BloombergLP/balm/DefaultMetricsManager.adoc[`DefaultMetricsManager`] 
| This struct provides a namespace for static functions that create, access, and destroy the default instance of the `MetricsManager`&period;
| xref:BloombergLP/balm/DefaultMetricsManagerScopedGuard.adoc[`DefaultMetricsManagerScopedGuard`] 
| This class implements a scoped guard for the default metrics manager&period;
| xref:BloombergLP/balm/IntegerCollector.adoc[`IntegerCollector`] 
| This class provides a mechanism for collecting and aggregating the value of an integer metric over a period of time&period;
| xref:BloombergLP/balm/IntegerMetric.adoc[`IntegerMetric`] 
| This class provides an in&hyphen;core value&hyphen;semantic type for recording integer metric values&period;
| xref:BloombergLP/balm/IntegerMetric_MacroImp.adoc[`IntegerMetric&lowbar;MacroImp`] 
| This structure provides a namespace for functions used to implement the macros defined by this component&period;
| xref:BloombergLP/balm/Metric.adoc[`Metric`] 
| This class provides an in&hyphen;core value semantic type for recording and aggregating the values of a metric&period;
| xref:BloombergLP/balm/MetricDescription.adoc[`MetricDescription`] 
| This class provides a mechanism for describing a metric&period;
| xref:BloombergLP/balm/MetricFormat.adoc[`MetricFormat`] 
| This class provides a value&hyphen;semantic description for the formatting of a metric&period;
| xref:BloombergLP/balm/MetricFormatSpec.adoc[`MetricFormatSpec`] 
| This class provides a value&hyphen;semantic representation of the formatting specification for a metric aggregate value&period;
| xref:BloombergLP/balm/MetricId.adoc[`MetricId`] 
| This class defines an in&hyphen;core value&hyphen;semantic type used to identify a metric&period;
| xref:BloombergLP/balm/MetricRecord.adoc[`MetricRecord`] 
| Each instance of this class represents the aggregated value of a metric&period;
| xref:BloombergLP/balm/MetricRegistry.adoc[`MetricRegistry`] 
| This class defines a thread&hyphen;aware mechanism for registering metrics and metric categories&period;
| xref:BloombergLP/balm/MetricSample.adoc[`MetricSample`] 
| This class provides an _in&hyphen;core_ value&hyphen;semantic representation of a sample of metric values&period;
| xref:BloombergLP/balm/MetricSampleGroup.adoc[`MetricSampleGroup`] 
| This class provides an _in&hyphen;core_ value&hyphen;semantic representation of a group of metric record values&period;
| xref:BloombergLP/balm/Metric_MacroImp.adoc[`Metric&lowbar;MacroImp`] 
| This structure provides a namespace for functions used to implement the macros defined by this component&period;
| xref:BloombergLP/balm/MetricsManager.adoc[`MetricsManager`] 
| This class implements a manager for the recording and publishing of metrics&period;
| xref:BloombergLP/balm/MetricsManager_CallbackRegistry.adoc[`MetricsManager&lowbar;CallbackRegistry`] 
| defined in implementation
| xref:BloombergLP/balm/MetricsManager_PublicationHelper.adoc[`MetricsManager&lowbar;PublicationHelper`] 
| defined in implementation
| xref:BloombergLP/balm/MetricsManager_PublisherRegistry.adoc[`MetricsManager&lowbar;PublisherRegistry`] 
| Private implementation type for the publisher registry&period;
| xref:BloombergLP/balm/Metrics_Helper.adoc[`Metrics&lowbar;Helper`] 
| This `struct` provides a namespace for a suite of functions used in the implementation of the macros defined in this component&period;
| xref:BloombergLP/balm/PublicationScheduler.adoc[`PublicationScheduler`] 
| This class defines a mechanism for scheduling the periodic publication of metrics&period;
| xref:BloombergLP/balm/PublicationScheduler_ClockData.adoc[`PublicationScheduler&lowbar;ClockData`] 
| Private implementation type for clock data used by the scheduler&period;
| xref:BloombergLP/balm/PublicationScheduler_Proctor.adoc[`PublicationScheduler&lowbar;Proctor`] 
| defined in implementation
| xref:BloombergLP/balm/PublicationType.adoc[`PublicationType`] 
| Enumeration of aggregation types used to publish metrics&period;
| xref:BloombergLP/balm/Publisher.adoc[`Publisher`] 
| This protocol class provides a method to publish recorded metric values&period;
| xref:BloombergLP/balm/StopwatchScopedGuard.adoc[`StopwatchScopedGuard`] 
| This class provides a mechanism for recording, to a metric, the elapsed time from construction of a guard instance until that instance is destroyed&period;
| xref:BloombergLP/balm/StreamPublisher.adoc[`StreamPublisher`] 
| This class provides a `Publisher` that writes metric samples to a stream&period;
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/operator_lshift-09.adoc[`operator&lt;&lt;`] 
| Stream insertion operators
| xref:BloombergLP/balm/operator_eq-03.adoc[`operator&equals;&equals;`] 
| Equality operators
| xref:BloombergLP/balm/operator_not_eq-00.adoc[`operator!&equals;`] 
| Inequality operators
| xref:BloombergLP/balm/operator_lt.adoc[`operator&lt;`] 
| Return `true` if the specified `lhs` metric id is less than (ordered before) the specified `rhs` metric id, and return `false` otherwise&apos;&period;
|===



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