histogram_view.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/utils/statistics/histogram_view.hpp
/// @brief @copybrief utils::statistics::HistogramView
 
#include <cstddef>
#include <cstdint>
#include <type_traits>
 
USERVER_NAMESPACE_BEGIN
 
namespace utils::statistics {
 
class Writer;
 
namespace impl::histogram {
struct Bucket;
struct Access;
}  // namespace impl::histogram
 
/// @brief The non-owning reader API for "histogram" metrics.
///
/// @see utils::statistics::Histogram for details on semantics
///
/// HistogramView is cheap to copy, expected to be passed around by value.
class HistogramView final {
 public:
  // trivially copyable
  HistogramView(const HistogramView&) noexcept = default;
  HistogramView& operator=(const HistogramView&) noexcept = default;
 
  /// Returns the number of "normal" (non-"infinity") buckets.
  std::size_t GetBucketCount() const noexcept;
 
  /// Returns the upper bucket boundary for the given bucket.
  double GetUpperBoundAt(std::size_t index) const;
 
  /// Returns the occurrence count for the given bucket.
  std::uint64_t GetValueAt(std::size_t index) const;
 
  /// Returns the occurrence count for the "infinity" bucket
  /// (greater than the largest bucket boundary).
  std::uint64_t GetValueAtInf() const noexcept;
 
  /// Returns the sum of counts from all buckets.
  std::uint64_t GetTotalCount() const noexcept;
 
 private:
  friend struct impl::histogram::Access;
 
  explicit HistogramView(const impl::histogram::Bucket* buckets) noexcept;
 
  const impl::histogram::Bucket* buckets_;
};
 
/// Compares equal if bounds are close and values are equal.
bool operator==(HistogramView lhs, HistogramView rhs) noexcept;
 
/// @overload
bool operator!=(HistogramView lhs, HistogramView rhs) noexcept;
 
}  // namespace utils::statistics
 
USERVER_NAMESPACE_END