BloombergLP::bdlm::MetricDescriptor::MetricDescriptor

Create an object of this class having the specified attribute values.

Synopsis

Declared in <bdlm_metricdescriptor.h>

MetricDescriptor(
    std::string_view const& metricNamespace,
    std::string_view const& metricName,
    InstanceCount::Value instanceNumber,
    std::string_view const& objectTypeName,
    std::string_view const& objectTypeAbbreviation,
    std::string_view const& objectIdentifier,
    bslma::Allocator* basicAllocator = 0);

Description

The attributes are the specified metricNamespace, metricName, instanceNumber, objectTypeName, objectTypeAbbreviation, and objectIdentifier. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used. Note that implementations of the bdlm::MetricsAdapter protocal will typically use an implementation specific value for the namespace attribute when metricNamespace == k_USE_METRICS_ADAPTER_NAMESPACE_SELECTION and the object identifier attribute when objectIdentrifier == k_USE_METRICS_ADAPTER_OBJECT_ID_SELECTION.

Parameters

NameDescription
metricNamespacegrouping value for published metrics
metricNamename of the metric
instanceNumberinstance number of the object generating the metric
objectTypeNamename of the type generating the metric
objectTypeAbbreviationabbreviation for the type generating the metric
objectIdentifierapplication unique identifier for the metric
basicAllocatormemory allocator; null uses the default