Performance statistics for logger operations. More...

#include <logger_metrics.h>

Collaboration diagram for kcenon::logger::metrics::logger_performance_stats:

Classes
struct	writer_stats_compat

Public Member Functions
	logger_performance_stats ()=default

	logger_performance_stats (const logger_performance_stats &other)

logger_performance_stats &	operator= (const logger_performance_stats &other)

	logger_performance_stats (logger_performance_stats &&other) noexcept

double	get_messages_per_second () const
	Get messages per second.

uint64_t	get_avg_enqueue_time_ns () const
	Get average enqueue time in nanoseconds.

double	get_queue_utilization_percent () const
	Get queue utilization percentage.

double	get_drop_rate_percent () const

double	get_bytes_per_second () const

void	reset ()
	Reset all statistics.

Public Attributes
std::atomic< uint64_t >	messages_logged {0}
	Total messages logged.

std::atomic< uint64_t >	messages_dropped {0}
	Messages dropped due to queue full.

std::atomic< uint64_t >	total_log_time_ns {0}
	Total time spent logging (nanoseconds)

std::atomic< uint64_t >	queue_size {0}
	Current queue size.

std::atomic< uint64_t >	max_queue_size {0}
	Maximum queue size reached.

std::atomic< uint64_t >	writer_errors {0}
	Number of writer errors.

std::atomic< uint64_t >	flush_operations {0}
	Number of flush operations.

std::atomic< uint64_t >	messages_enqueued {0}
	Legacy alias for enqueued messages.

std::atomic< uint64_t >	messages_processed {0}
	Legacy alias for processed messages.

std::map< std::string, writer_stats_compat >	writer_stats
	Legacy per-writer statistics.

Detailed Description

Performance statistics for logger operations.

Examples: metrics_demo.cpp.

Definition at line 25 of file logger_metrics.h.

Constructor & Destructor Documentation

◆ logger_performance_stats() [1/3]

kcenon::logger::metrics::logger_performance_stats::logger_performance_stats ( )

default

◆ logger_performance_stats() [2/3]

kcenon::logger::metrics::logger_performance_stats::logger_performance_stats ( const logger_performance_stats & other )

inline

Definition at line 50 of file logger_metrics.h.

        : messages_logged(other.messages_logged.load()),
          messages_dropped(other.messages_dropped.load()),
          total_log_time_ns(other.total_log_time_ns.load()),
          queue_size(other.queue_size.load()),
          max_queue_size(other.max_queue_size.load()),
          writer_errors(other.writer_errors.load()),
          flush_operations(other.flush_operations.load()),
          messages_enqueued(other.messages_enqueued.load()),
          messages_processed(other.messages_processed.load()),
          writer_stats(other.writer_stats) {}

◆ logger_performance_stats() [3/3]

kcenon::logger::metrics::logger_performance_stats::logger_performance_stats ( logger_performance_stats && other )

inlinenoexcept

Definition at line 79 of file logger_metrics.h.

        : messages_logged(other.messages_logged.load()),
          messages_dropped(other.messages_dropped.load()),
          total_log_time_ns(other.total_log_time_ns.load()),
          queue_size(other.queue_size.load()),
          max_queue_size(other.max_queue_size.load()),
          writer_errors(other.writer_errors.load()),
          flush_operations(other.flush_operations.load()),
          messages_enqueued(other.messages_enqueued.load()),
          messages_processed(other.messages_processed.load()),
          writer_stats(std::move(other.writer_stats)) {}

Member Function Documentation

◆ get_avg_enqueue_time_ns()

uint64_t kcenon::logger::metrics::logger_performance_stats::get_avg_enqueue_time_ns ( ) const

inline

Get average enqueue time in nanoseconds.

Examples: metrics_demo.cpp.

Definition at line 104 of file logger_metrics.h.

                                             {
        auto msgs = messages_logged.load();
        auto time_ns = total_log_time_ns.load();
        if (msgs == 0) return 0;
        return time_ns / msgs;
    }

References messages_logged, and total_log_time_ns.

Referenced by print_metrics().

Here is the caller graph for this function:

◆ get_bytes_per_second()

double kcenon::logger::metrics::logger_performance_stats::get_bytes_per_second ( ) const

inline

Definition at line 130 of file logger_metrics.h.

                                        {
        return 0.0;
    }

◆ get_drop_rate_percent()

double kcenon::logger::metrics::logger_performance_stats::get_drop_rate_percent ( ) const

inline

Definition at line 121 of file logger_metrics.h.

                                         {
        auto enqueued = messages_enqueued.load();
        if (enqueued == 0) {
            return 0.0;
        }
        auto dropped = messages_dropped.load();
        return static_cast<double>(dropped) * 100.0 / static_cast<double>(enqueued);
    }

References messages_dropped, and messages_enqueued.

◆ get_messages_per_second()

double kcenon::logger::metrics::logger_performance_stats::get_messages_per_second ( ) const

inline

Get messages per second.

Examples: metrics_demo.cpp.

Definition at line 94 of file logger_metrics.h.

                                           {
        auto msgs = messages_logged.load();
        auto time_ns = total_log_time_ns.load();
        if (time_ns == 0) return 0.0;
        return static_cast<double>(msgs) * 1'000'000'000.0 / static_cast<double>(time_ns);
    }

References messages_logged, and total_log_time_ns.

Referenced by print_metrics().

Here is the caller graph for this function:

◆ get_queue_utilization_percent()

double kcenon::logger::metrics::logger_performance_stats::get_queue_utilization_percent ( ) const

inline

Get queue utilization percentage.

Examples: metrics_demo.cpp.

Definition at line 114 of file logger_metrics.h.

                                                 {
        auto current = queue_size.load();
        auto max_size = max_queue_size.load();
        if (max_size == 0) return 0.0;
        return static_cast<double>(current) * 100.0 / static_cast<double>(max_size);
    }

References max_queue_size, and queue_size.

Referenced by print_metrics().

Here is the caller graph for this function:

◆ operator=()

logger_performance_stats & kcenon::logger::metrics::logger_performance_stats::operator= ( const logger_performance_stats & other )

inline

Definition at line 62 of file logger_metrics.h.

                                                                               {
        if (this != &other) {
            messages_logged.store(other.messages_logged.load());
            messages_dropped.store(other.messages_dropped.load());
            total_log_time_ns.store(other.total_log_time_ns.load());
            queue_size.store(other.queue_size.load());
            max_queue_size.store(other.max_queue_size.load());
            writer_errors.store(other.writer_errors.load());
            flush_operations.store(other.flush_operations.load());
            messages_enqueued.store(other.messages_enqueued.load());
            messages_processed.store(other.messages_processed.load());
            writer_stats = other.writer_stats;
        }
        return *this;
    }

References flush_operations, max_queue_size, messages_dropped, messages_enqueued, messages_logged, messages_processed, queue_size, total_log_time_ns, writer_errors, and writer_stats.

◆ reset()

void kcenon::logger::metrics::logger_performance_stats::reset ( )

inline

Reset all statistics.

Definition at line 137 of file logger_metrics.h.

                 {
        messages_logged.store(0);
        messages_dropped.store(0);
        total_log_time_ns.store(0);
        queue_size.store(0);
        max_queue_size.store(0);
        writer_errors.store(0);
        flush_operations.store(0);
        messages_enqueued.store(0);
        messages_processed.store(0);
        writer_stats.clear();
    }