A console writer that counts messages per log level. More...

Inheritance diagram for counted_console_writer:

Collaboration diagram for counted_console_writer:

Public Member Functions
	counted_console_writer ()

std::string	get_name () const override

size_t	get_count (kcenon::common::interfaces::log_level level) const
	Get count for a specific log level.

size_t	total_count () const
	Get total message count.

void	print_stats () const
	Print statistics summary.

Public Member Functions inherited from kcenon::logger::thread_safe_writer
	thread_safe_writer (std::unique_ptr< log_formatter_interface > formatter=nullptr)
	Constructor with optional formatter.

	~thread_safe_writer () override=default
	Virtual destructor.

	thread_safe_writer (const thread_safe_writer &)=delete

thread_safe_writer &	operator= (const thread_safe_writer &)=delete

	thread_safe_writer (thread_safe_writer &&)=delete

thread_safe_writer &	operator= (thread_safe_writer &&)=delete

common::VoidResult	write (const log_entry &entry) final
	Thread-safe write operation for structured log entries.

common::VoidResult	flush () final
	Thread-safe flush operation.

Public Member Functions inherited from kcenon::logger::base_writer
	base_writer (std::unique_ptr< log_formatter_interface > formatter=nullptr)
	Constructor with optional formatter.

virtual	~base_writer ()=default

virtual void	set_use_color (bool use_color)
	Set whether to use color output (if supported)

bool	use_color () const
	Get current color output setting.

virtual bool	is_healthy () const override
	Check if the writer is healthy and operational.

log_formatter_interface *	get_formatter () const
	Get the current formatter.

Public Member Functions inherited from kcenon::logger::log_writer_interface
virtual	~log_writer_interface ()=default

virtual common::VoidResult	close ()
	Close the writer and release resources.

virtual auto	is_open () const -> bool
	Check if writer is open and ready.

Protected Member Functions
kcenon::common::VoidResult	write_entry_impl (const log_entry &entry) override
	Implementation of structured write operation (override in derived classes)

kcenon::common::VoidResult	flush_impl () override
	Implementation of flush operation (override in derived classes)

Protected Member Functions inherited from kcenon::logger::thread_safe_writer
std::mutex &	get_mutex () const
	Access the writer mutex for extended operations.

Protected Member Functions inherited from kcenon::logger::base_writer
std::string	format_log_entry (const log_entry &entry) const
	Format a log entry using the current formatter.

Private Attributes
std::map< kcenon::common::interfaces::log_level, size_t >	counts_

Detailed Description

A console writer that counts messages per log level.

Demonstrates extending thread_safe_writer for console output with statistics.

Examples: custom_writer_example.cpp.

Definition at line 121 of file custom_writer_example.cpp.

Constructor & Destructor Documentation

◆ counted_console_writer()

counted_console_writer::counted_console_writer ( )

inline

Examples: custom_writer_example.cpp.

Definition at line 123 of file custom_writer_example.cpp.

                             {
        // Initialize counters for each log level
        for (int i = 0; i <= static_cast<int>(kcenon::common::interfaces::log_level::trace); ++i) {
            counts_[static_cast<kcenon::common::interfaces::log_level>(i)] = 0;
        }
    }

References counts_.

Member Function Documentation

◆ flush_impl()

kcenon::common::VoidResult counted_console_writer::flush_impl ( )

inlineoverrideprotectedvirtual

Implementation of flush operation (override in derived classes)

Returns: common::VoidResult Success or error code

Called by flush() while holding the mutex. Derived classes implement their output-specific flush logic here.

Note: The mutex is held when this method is called.; Do not call public methods on 'this' (would cause deadlock).

Since: 1.3.0

Implements kcenon::logger::thread_safe_writer.

Examples: custom_writer_example.cpp.

Definition at line 206 of file custom_writer_example.cpp.

                                                 {
        std::cout.flush();
        std::cerr.flush();
        return kcenon::common::ok();
    }

References kcenon::common::ok().

Here is the call graph for this function:

◆ get_count()

size_t counted_console_writer::get_count ( kcenon::common::interfaces::log_level level ) const

inline

Get count for a specific log level.

Examples: custom_writer_example.cpp.

Definition at line 137 of file custom_writer_example.cpp.

                                                                  {
        std::lock_guard<std::mutex> lock(get_mutex());
        auto it = counts_.find(level);
        return (it != counts_.end()) ? it->second : 0;
    }

References counts_, and kcenon::logger::thread_safe_writer::get_mutex().

Here is the call graph for this function:

◆ get_name()

std::string counted_console_writer::get_name ( ) const

inlineoverridevirtual

Implements kcenon::logger::base_writer.

Examples: custom_writer_example.cpp.

Definition at line 130 of file custom_writer_example.cpp.

                                        {
        return "counted_console";
    }

◆ print_stats()

void counted_console_writer::print_stats ( ) const

inline

Print statistics summary.

Examples: custom_writer_example.cpp.

Definition at line 158 of file custom_writer_example.cpp.

                             {
        std::lock_guard<std::mutex> lock(get_mutex());
        std::cout << "\n=== Log Statistics ===" << std::endl;
        std::cout << "Fatal:   " << counts_.at(kcenon::common::interfaces::log_level::fatal) << std::endl;
        std::cout << "Error:   " << counts_.at(kcenon::common::interfaces::log_level::error) << std::endl;
        std::cout << "Warning: " << counts_.at(kcenon::common::interfaces::log_level::warning) << std::endl;
        std::cout << "Info:    " << counts_.at(kcenon::common::interfaces::log_level::info) << std::endl;
        std::cout << "Debug:   " << counts_.at(kcenon::common::interfaces::log_level::debug) << std::endl;
        std::cout << "Trace:   " << counts_.at(kcenon::common::interfaces::log_level::trace) << std::endl;
    }

References counts_, and kcenon::logger::thread_safe_writer::get_mutex().

Here is the call graph for this function:

◆ total_count()

size_t counted_console_writer::total_count ( ) const

inline

Get total message count.

Examples: custom_writer_example.cpp.

Definition at line 146 of file custom_writer_example.cpp.

                               {
        std::lock_guard<std::mutex> lock(get_mutex());
        size_t total = 0;
        for (const auto& [level, count] : counts_) {
            total += count;
        }
        return total;
    }

References counts_, and kcenon::logger::thread_safe_writer::get_mutex().

Here is the call graph for this function:

◆ write_entry_impl()

kcenon::common::VoidResult counted_console_writer::write_entry_impl ( const log_entry & entry )

inlineoverrideprotectedvirtual

Implementation of structured write operation (override in derived classes)

Parameters

entry The log entry to write (includes structured fields)

Returns: common::VoidResult Success or error code

Called by write(const log_entry&) while holding the mutex. Derived classes must override this method to implement their output logic.

Note: The mutex is held when this method is called.; Do not call public methods on 'this' (would cause deadlock).

Since: 3.4.0; 3.5.0 Now pure virtual - implementations must override this

Implements kcenon::logger::thread_safe_writer.

Examples: custom_writer_example.cpp.

Definition at line 170 of file custom_writer_example.cpp.

    {
        // Convert log_level from logger_system to common::interfaces
        auto level = static_cast<kcenon::common::interfaces::log_level>(static_cast<int>(entry.level));
 
        // Increment counter for this level
        counts_[level]++;
 
        // Format log entry
        std::string formatted = format_log_entry(entry);
 
        // Output to console with color based on level
        if (use_color()) {
            switch (level) {
                case kcenon::common::interfaces::log_level::fatal:
                case kcenon::common::interfaces::log_level::error:
                    std::cerr << "\033[31m" << formatted << "\033[0m" << std::endl;
                    break;
                case kcenon::common::interfaces::log_level::warning:
                    std::cout << "\033[33m" << formatted << "\033[0m" << std::endl;
                    break;
                default:
                    std::cout << formatted << std::endl;
                    break;
            }
        } else {
            if (level <= kcenon::common::interfaces::log_level::error) {
                std::cerr << formatted << std::endl;
            } else {
                std::cout << formatted << std::endl;
            }
        }
 
        return kcenon::common::ok();
    }