kcenon::logger::file_sink Class Reference

Writes log messages to a file. More...

#include <file_sink.h>

Inheritance diagram for kcenon::logger::file_sink:

Collaboration diagram for kcenon::logger::file_sink:

Public Member Functions
	file_sink (const std::string &file_path, bool append=true)
	Construct a file sink.
	~file_sink () override
common::VoidResult	write_raw (std::string_view message) override
	Write a pre-formatted message to the output destination.
common::VoidResult	flush () override
	Flush any buffered data.
bool	is_healthy () const override
	Check if the sink is healthy.
std::string	get_name () const override
	Get the name of this sink.
std::string	get_info () const override
	Get sink information.
std::string	get_file_path () const
	Get the file path.
Public Member Functions inherited from kcenon::logger::output_sink_interface
virtual	~output_sink_interface ()=default

Private Attributes
std::string	file_path_
std::ofstream	file_
std::mutex	mutex_
bool	is_healthy_

Detailed Description

Writes log messages to a file.

Thread-safe file output sink. Handles file I/O only, no formatting logic.

Thread Safety:

All methods are thread-safe.

See also

output_sink_interface Base interface for all output sinks

logger Main logger that uses sinks to write messages

Since

1.3.0

Definition at line 35 of file file_sink.h.

Constructor & Destructor Documentation

file_sink()

kcenon::logger::file_sink::file_sink ( const std::string & file_path, bool append = true )

inlineexplicit

Construct a file sink.

Parameters

file_path	Path to the output file
append	If true, append to existing file; if false, truncate

Definition at line 42 of file file_sink.h.

        : file_path_(file_path)
        , is_healthy_(false)
    {
        auto mode = append ? (std::ios::out | std::ios::app) : std::ios::out;
        file_.open(file_path, mode);
        is_healthy_ = file_.is_open() && file_.good();
    }

References file_, and is_healthy_.

~file_sink()

kcenon::logger::file_sink::~file_sink ( )

inlineoverride

Definition at line 51 of file file_sink.h.

                          {
        if (file_.is_open()) {
            file_.flush();
            file_.close();
        }
    }

References file_.

Member Function Documentation

flush()

common::VoidResult kcenon::logger::file_sink::flush ( )

inlineoverridevirtual

Flush any buffered data.

Returns

common::VoidResult Success or error code

Implements kcenon::logger::output_sink_interface.

Definition at line 76 of file file_sink.h.

                                      {
        std::lock_guard<std::mutex> lock(mutex_);
 
        if (!file_.is_open()) {
            return make_logger_void_result(logger_error_code::file_write_failed);
        }
 
        file_.flush();
 
        if (file_.fail()) {
            is_healthy_ = false;
            return make_logger_void_result(logger_error_code::file_write_failed);
        }
 
        return common::ok();
    }

References file_, kcenon::logger::file_write_failed, is_healthy_, kcenon::logger::make_logger_void_result(), mutex_, and kcenon::common::ok().

Here is the call graph for this function:

get_file_path()

std::string kcenon::logger::file_sink::get_file_path ( ) const

inline

Get the file path.

Returns

File path

Definition at line 119 of file file_sink.h.

                                    {
        return file_path_;
    }

References file_path_.

get_info()

std::string kcenon::logger::file_sink::get_info ( ) const

inlineoverridevirtual

Get sink information.

Returns

Diagnostic string

Reimplemented from kcenon::logger::output_sink_interface.

Definition at line 101 of file file_sink.h.

                                        {
        std::lock_guard<std::mutex> lock(mutex_);
        std::string info = "file: " + file_path_;
        if (file_.is_open()) {
            try {
                auto size = std::filesystem::file_size(file_path_);
                info += ", size: " + std::to_string(size / 1024) + "KB";
            } catch (...) {
                // Ignore file size error
            }
        }
        return info;
    }

References file_, file_path_, mutex_, and kcenon::logger::size.

get_name()

std::string kcenon::logger::file_sink::get_name ( ) const

inlineoverridevirtual

Get the name of this sink.

Returns

Sink identifier

Implements kcenon::logger::output_sink_interface.

Definition at line 97 of file file_sink.h.

                                        {
        return "file";
    }

is_healthy()

bool kcenon::logger::file_sink::is_healthy ( ) const

inlineoverridevirtual

Check if the sink is healthy.

Returns

true if operational

Implements kcenon::logger::output_sink_interface.

Definition at line 93 of file file_sink.h.

                                     {
        return is_healthy_ && file_.is_open() && file_.good();
    }

References file_, and is_healthy_.

write_raw()

common::VoidResult kcenon::logger::file_sink::write_raw ( std::string_view message )

inlineoverridevirtual

Write a pre-formatted message to the output destination.

Parameters

message

Pre-formatted log message

Returns

common::VoidResult Success or error code

Implements kcenon::logger::output_sink_interface.

Definition at line 58 of file file_sink.h.

                                                                {
        std::lock_guard<std::mutex> lock(mutex_);
 
        if (!file_.is_open() || !file_.good()) {
            is_healthy_ = false;
            return make_logger_void_result(logger_error_code::file_write_failed);
        }
 
        file_ << message;
 
        if (file_.fail()) {
            is_healthy_ = false;
            return make_logger_void_result(logger_error_code::file_write_failed);
        }
 
        return common::ok();
    }

References file_, kcenon::logger::file_write_failed, is_healthy_, kcenon::logger::make_logger_void_result(), mutex_, and kcenon::common::ok().

Here is the call graph for this function:

Member Data Documentation

file_

std::ofstream kcenon::logger::file_sink::file_

private

Definition at line 125 of file file_sink.h.

Referenced by file_sink(), flush(), get_info(), is_healthy(), write_raw(), and ~file_sink().

file_path_

std::string kcenon::logger::file_sink::file_path_

private

Definition at line 124 of file file_sink.h.

Referenced by get_file_path(), and get_info().

is_healthy_

bool kcenon::logger::file_sink::is_healthy_

private

Definition at line 127 of file file_sink.h.

Referenced by file_sink(), flush(), is_healthy(), and write_raw().

mutex_

std::mutex kcenon::logger::file_sink::mutex_

mutableprivate

Definition at line 126 of file file_sink.h.

Referenced by flush(), get_info(), and write_raw().

---

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

• include/kcenon/logger/sinks/file_sink.h