IHistogram#

Fully qualified name: omni::observability::IHistogram

Defined in omni/observability/IMetrics.h

template<class ValueType_>
class IHistogram : public carb::IObject#

Histogram instrument for recording distributions of values.

Remark

Histograms are used to measure the distribution of values, such as request latencies, response sizes, or processing times. They automatically create buckets to track value distributions.

Public Types

using ValueType = ValueType_#

The value type for this histogram (e.g., std::uint64_t or double).

Public Functions

virtual ~IHistogram() = default#
virtual void recordArr(
ValueType value,
const Attribute attributes[],
std::size_t attributeCount,
) noexcept = 0#

Record a value in the histogram with attributes.

Parameters:

  • value – [in] The value to record in the histogram.

  • attributes – [in] Array of attributes to associate with this measurement.

  • attributeCount – [in] Number of attributes in the array.

template<class T, class ...A>
inline void record(
T value,
A&&... a,
) noexcept#

Record a value in the histogram with variadic attributes.

Parameters:

  • value – [in] The value to record in the histogram.

  • a – [in] Variadic list of attributes to associate with this measurement.

template<class T>
inline void record(
T value,
std::initializer_list<Attribute> attributes,
) noexcept#

Record a value in the histogram with initializer list of attributes.

Parameters:

  • value – [in] The value to record in the histogram.

  • attributes – [in] Initializer list of attributes to associate with this measurement.

virtual size_t addRef() = 0#

Atomically add one to the reference count.

Returns:

The current reference count after one was added, though this value may change before read if other threads are also modifying the reference count. The return value is guaranteed to be non-zero.

virtual size_t release() = 0#

Atomically subtracts one from the reference count.

If the result is zero, carb::deleteHandler() is called for this.

Returns:

The current reference count after one was subtracted. If zero is returned, carb::deleteHandler() was called for this.

Public Static Functions

static inline constexpr carb::InterfaceDesc getInterfaceDesc(
) noexcept#

Returns information about this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

The carb::InterfaceDesc struct with information about this interface.

static inline constexpr carb::InterfaceDesc getLatestInterfaceDesc(
) noexcept#

Returns information about the latest version of this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

The carb::InterfaceDesc struct with information about the latest version of this interface.