kcenon::monitoring::histogram_data Struct Reference

Histogram data with buckets. More...

#include <metric_types.h>

Collaboration diagram for kcenon::monitoring::histogram_data:

Public Member Functions
void	add_sample (double value)
	Add value to histogram.
double	mean () const noexcept
	Get mean value.
void	init_standard_buckets ()
	Initialize standard buckets.

Public Attributes
std::vector< histogram_bucket >	buckets
uint64_t	total_count = 0
double	sum = 0.0

Detailed Description

Histogram data with buckets.

Examples

custom_metric_types_example.cpp.

Definition at line 275 of file metric_types.h.

Member Function Documentation

add_sample()

void kcenon::monitoring::histogram_data::add_sample ( double value )

inline

Add value to histogram.

Examples

custom_metric_types_example.cpp.

Definition at line 283 of file metric_types.h.

                                  {
        sum += value;
        total_count++;
        
        for (auto& bucket : buckets) {
            if (value <= bucket.upper_bound) {
                bucket.count++;
            }
        }
    }

References buckets, sum, and total_count.

Referenced by demonstrate_histogram(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

init_standard_buckets()

void kcenon::monitoring::histogram_data::init_standard_buckets ( )

inline

Initialize standard buckets.

Definition at line 304 of file metric_types.h.

                                 {
        buckets = {
            {0.005, 0}, {0.01, 0}, {0.025, 0}, {0.05, 0}, {0.075, 0},
            {0.1, 0}, {0.25, 0}, {0.5, 0}, {0.75, 0}, {1.0, 0},
            {2.5, 0}, {5.0, 0}, {7.5, 0}, {10.0, 0}, 
            {std::numeric_limits<double>::infinity(), 0}
        };
    }

References buckets.

Referenced by TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

mean()

double kcenon::monitoring::histogram_data::mean ( ) const

inlinenoexcept

Get mean value.

Examples

custom_metric_types_example.cpp.

Definition at line 297 of file metric_types.h.

                                 {
        return total_count > 0 ? sum / total_count : 0.0;
    }

References sum, and total_count.

Referenced by demonstrate_histogram(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

Member Data Documentation

buckets

std::vector<histogram_bucket> kcenon::monitoring::histogram_data::buckets

Examples

custom_metric_types_example.cpp.

Definition at line 276 of file metric_types.h.

Referenced by add_sample(), demonstrate_histogram(), init_standard_buckets(), TEST_F(), and TEST_F().

sum

double kcenon::monitoring::histogram_data::sum = 0.0

Examples

custom_metric_types_example.cpp.

Definition at line 278 of file metric_types.h.

Referenced by add_sample(), demonstrate_histogram(), mean(), TEST_F(), and TEST_F().

total_count

uint64_t kcenon::monitoring::histogram_data::total_count = 0

Examples

custom_metric_types_example.cpp.

Definition at line 277 of file metric_types.h.

Referenced by add_sample(), demonstrate_histogram(), mean(), TEST_F(), and TEST_F().

---

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

• include/kcenon/monitoring/utils/metric_types.h