Summary statistics for metrics. More...

#include <metric_types.h>

Collaboration diagram for kcenon::monitoring::summary_data:

Public Member Functions
void	add_sample (double value)
	Add sample to summary.

double	mean () const noexcept
	Get mean value.

void	reset ()
	Reset summary.

Public Attributes
uint64_t	count = 0

double	sum = 0.0

double	min_value = (std::numeric_limits<double>::max)()

double	max_value = (std::numeric_limits<double>::lowest)()

Detailed Description

Summary statistics for metrics.

Examples: custom_metric_types_example.cpp.

Definition at line 318 of file metric_types.h.

Member Function Documentation

◆ add_sample()

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

inline

Add sample to summary.

Examples: custom_metric_types_example.cpp.

Definition at line 327 of file metric_types.h.

                                  {
        count++;
        sum += value;
        min_value = (std::min)(min_value, value);
        max_value = (std::max)(max_value, value);
    }

References count, max_value, min_value, and sum.

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

Here is the caller graph for this function:

◆ mean()

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

inlinenoexcept

Get mean value.

Examples: custom_metric_types_example.cpp.

Definition at line 337 of file metric_types.h.

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

References count, and sum.

Referenced by demonstrate_summary().

Here is the caller graph for this function:

◆ reset()

void kcenon::monitoring::summary_data::reset ( )

inline

Reset summary.

Examples: custom_metric_types_example.cpp.

Definition at line 344 of file metric_types.h.

                 {
        count = 0;
        sum = 0.0;
        min_value = (std::numeric_limits<double>::max)();
        max_value = (std::numeric_limits<double>::lowest)();
    }