kcenon::logger::sampling::sampling_stats Struct Reference

Statistics about sampling behavior. More...

#include <sampling_config.h>

Collaboration diagram for kcenon::logger::sampling::sampling_stats:

Public Member Functions
double	actual_ratio () const
	Calculate the actual sampling ratio.
void	reset ()
	Reset all statistics.

Public Attributes
std::uint64_t	total_count = 0
	Total number of log messages considered for sampling.
std::uint64_t	sampled_count = 0
	Number of messages that passed sampling (were logged)
std::uint64_t	dropped_count = 0
	Number of messages dropped due to sampling.
std::uint64_t	bypassed_count = 0
	Number of messages that bypassed sampling (always_log levels)
double	effective_rate = 1.0
	Current effective sampling rate.
bool	is_throttling = false
	Whether adaptive sampling is currently reducing the rate.

Detailed Description

Statistics about sampling behavior.

Tracks sampling metrics for monitoring and debugging purposes. All counters are thread-safe when accessed through the sampler API.

Since

3.3.0

Definition at line 305 of file sampling_config.h.

Member Function Documentation

actual_ratio()

double kcenon::logger::sampling::sampling_stats::actual_ratio ( ) const

inlinenodiscard

Calculate the actual sampling ratio.

Returns

Ratio of sampled messages to total messages

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 341 of file sampling_config.h.

                                              {
        if (total_count == 0) {
            return 1.0;
        }
        return static_cast<double>(sampled_count + bypassed_count) /
               static_cast<double>(total_count);
    }

References bypassed_count, sampled_count, and total_count.

reset()

void kcenon::logger::sampling::sampling_stats::reset ( )

inline

Reset all statistics.

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 352 of file sampling_config.h.

                 {
        total_count = 0;
        sampled_count = 0;
        dropped_count = 0;
        bypassed_count = 0;
        effective_rate = 1.0;
        is_throttling = false;
    }

References bypassed_count, dropped_count, effective_rate, is_throttling, sampled_count, and total_count.

Member Data Documentation

bypassed_count

std::uint64_t kcenon::logger::sampling::sampling_stats::bypassed_count = 0

Number of messages that bypassed sampling (always_log levels)

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 324 of file sampling_config.h.

Referenced by actual_ratio(), kcenon::logger::sampling::log_sampler::get_stats(), and reset().

dropped_count

std::uint64_t kcenon::logger::sampling::sampling_stats::dropped_count = 0

Number of messages dropped due to sampling.

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 319 of file sampling_config.h.

Referenced by kcenon::logger::sampling::log_sampler::get_stats(), and reset().

effective_rate

double kcenon::logger::sampling::sampling_stats::effective_rate = 1.0

Current effective sampling rate.

May differ from configured rate when adaptive sampling is active

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 330 of file sampling_config.h.

Referenced by kcenon::logger::sampling::log_sampler::get_stats(), and reset().

is_throttling

bool kcenon::logger::sampling::sampling_stats::is_throttling = false

Whether adaptive sampling is currently reducing the rate.

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 335 of file sampling_config.h.

Referenced by kcenon::logger::sampling::log_sampler::get_stats(), and reset().

sampled_count

std::uint64_t kcenon::logger::sampling::sampling_stats::sampled_count = 0

Number of messages that passed sampling (were logged)

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 314 of file sampling_config.h.

Referenced by actual_ratio(), kcenon::logger::sampling::log_sampler::get_stats(), and reset().

total_count

std::uint64_t kcenon::logger::sampling::sampling_stats::total_count = 0

Total number of log messages considered for sampling.

Examples

/home/runner/work/logger_system/logger_system/include/kcenon/logger/sampling/sampling_config.h.

Definition at line 309 of file sampling_config.h.

Referenced by actual_ratio(), kcenon::logger::sampling::log_sampler::get_stats(), and reset().

---

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

• include/kcenon/logger/sampling/sampling_config.h