bdlm::MetricsRegistry Class Reference

#include <bdlm_metricsregistry.h>

Detailed Description

This class implements a mechanism that provides a registry of metrics that is transferable to implementations of the bdlm::MetricsAdapter protocol. This class is usually a singleton.

See bdlm_metricsregistry

Public Types
typedef MetricsAdapter::Callback	Callback
typedef MetricsAdapter::CallbackHandle	CallbackHandle

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (MetricsRegistry, bslma::UsesBslmaAllocator)
	MetricsRegistry (bslma::Allocator *basicAllocator=0)
	~MetricsRegistry ()
int	disableMetricsCollection ()
int	enableMetricsCollection ()
int	registerCollectionCallback (MetricsRegistryRegistrationHandle *result, const bdlm::MetricDescriptor &descriptor, const Callback &callback)
int	removeMetricsAdapter (MetricsAdapter *adapter)
int	setMetricsAdapter (MetricsAdapter *adapter)
int	numRegisteredCollectionCallbacks () const
bslma::Allocator *	allocator () const

Static Public Member Functions
static MetricsRegistry &	defaultInstance ()

Member Typedef Documentation

Callback

typedef MetricsAdapter::Callback bdlm::MetricsRegistry::Callback

CallbackHandle

typedef MetricsAdapter::CallbackHandle bdlm::MetricsRegistry::CallbackHandle

Constructor & Destructor Documentation

MetricsRegistry()

bdlm::MetricsRegistry::MetricsRegistry ( bslma::Allocator *  basicAllocator = 0 )

explicit

Create a MetricsRegistry object that stores the information necessary to forward the registration and unregistration of metrics to an adapter supplied with setMetricsRegistry. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

~MetricsRegistry()

bdlm::MetricsRegistry::~MetricsRegistry

(

)

Unregister all registered metrics and destroy this MetricsRegistry object.

Member Function Documentation

allocator()

bslma::Allocator * bdlm::MetricsRegistry::allocator

(

)

const

Return the allocator used by this object to supply memory.

BSLMF_NESTED_TRAIT_DECLARATION()

bdlm::MetricsRegistry::BSLMF_NESTED_TRAIT_DECLARATION	(	MetricsRegistry	,
		bslma::UsesBslmaAllocator
	)

defaultInstance()

static MetricsRegistry & bdlm::MetricsRegistry::defaultInstance ( )

static

Return a non-const reference to the metrics registry singleton.

disableMetricsCollection()

int bdlm::MetricsRegistry::disableMetricsCollection

(

)

Disable metrics collection. If there is an associated metrics adapter, all the collection callbacks are unregistered from that adapter. The adapter remains associated with this registry. Collection callbacks registered with this registry are not registered with the associated adapter until metrics collections is enabled. Return 0 on success, and a non-zero value otherwise. Metrics collection is enabled at construction of this registry.

enableMetricsCollection()

int bdlm::MetricsRegistry::enableMetricsCollection

(

)

Enable metrics collection. If there is an associated metrics adapter, all collection callbacks will be registered with the adapter. Return 0 on success, and non-zero value otherwise. Metrics collection is enabled at construction of this registry.

numRegisteredCollectionCallbacks()

int bdlm::MetricsRegistry::numRegisteredCollectionCallbacks

(

)

const

Return the number of registered metrics collection callbacks.

registerCollectionCallback()

int bdlm::MetricsRegistry::registerCollectionCallback	(	MetricsRegistryRegistrationHandle *	result,
		const bdlm::MetricDescriptor &	descriptor,
		const Callback &	callback
	)

Register the metric described by the specified descriptor and associate it with the specified callback to collect data from the metric, and load the specified result with a handle can be used later to unregister the metric. Return 0 on success, and a non-zero value otherwise. After this operation completes, result->isRegistered() will be true. The metric and associated callback remain registered with this registry until either the handle is unregistered or destroyed. When a MetricsAdapter is associated with this registry using setMetricsAdapter, this object registers all the registered metrics and callbacks with that adapter, and similarly unregisters them if the MetricAdapter is later disassociated with this registry (either on this objects destruction, or due to a call to removeMetricsAdapter or setMetricsAdapter). Furthermore, metrics collection can be disable with disableMetricsCollection and enabled with enableMetricsCollection. In this way, a MetricsRegistry serves as an intermediary between users of bdlm that register metrics and the subsystem for collecting and publishing metrics being adapted by a concrete instance of bdlm::MetricAdapter.

removeMetricsAdapter()

int bdlm::MetricsRegistry::removeMetricsAdapter

(

MetricsAdapter *

adapter

)

If the specified adapter is the currently associated adapter, remove all registered metrics from it and disassociate with this registry. Return 0 on success, and a non-zero value otherwise.

Note

Note that this operation takes an adapter to disambiguate multiple, potentially concurrent, calls to this method and setMetricsAdapter.

setMetricsAdapter()

int bdlm::MetricsRegistry::setMetricsAdapter

(

MetricsAdapter *

adapter

)

Configure this metrics registry to register all metrics collection callbacks with the specified adapter when the registry has metrics collection enabled. This operation first, if there is already an associated metrics adapter, unregisters all the collection callbacks from that adapter, then registers the collection callbacks with the new adapter if metrics collection is enabled. Return 0 on success, and a non-zero value otherwise.

---

The documentation for this class was generated from the following file:

• bdlm_metricsregistry.h