logging::MRDTConsoleSink Class Reference

A custom console sink for logging messages with specific formatting and timestamping. This class extends quill::ConsoleSink and provides the capability to format log messages using a specified pattern and time format, allowing for customizable and colorized console outputs. More...

#include <AutonomyLogging.h>

Inheritance diagram for logging::MRDTConsoleSink:

Collaboration diagram for logging::MRDTConsoleSink:

Public Member Functions
	MRDTConsoleSink (const quill::ConsoleSinkConfig::Colours &qColors, const quill::ConsoleSinkConfig::ColourMode &qColorMode, const std::string &szFormatPattern, const std::string &szTimeFormat, quill::Timezone qTimestampTimezone=quill::Timezone::LocalTime, const std::string &szStream="stdout")
	Constructs a new MRDTConsoleSink object with specified formatting and console colors. This constructor initializes the sink with a log message pattern, timestamp format, and optional timezone settings. The constructor also allows customization of the output szStream.
void	write_log (const quill::MacroMetadata *qLogMetadata, uint64_t unLogTimestamp, std::string_view szThreadID, std::string_view szThreadName, const std::string &szProcessID, std::string_view szLoggerName, quill::LogLevel qLogLevel, std::string_view szLogLevelDescription, std::string_view szLogLevelShortCode, const std::vector< std::pair< std::string, std::string > > *vNamedArgs, std::string_view szLogMessage, std::string_view) override
	Writes a log message to the MRDT console sink, formats the message using the provided formatter, and then passes the formatted log message along with the original data to the parent class (ConsoleSink) for handling.

Private Attributes
quill::PatternFormatter	qFormatter

Detailed Description

A custom console sink for logging messages with specific formatting and timestamping. This class extends quill::ConsoleSink and provides the capability to format log messages using a specified pattern and time format, allowing for customizable and colorized console outputs.

This class is intended to be used in scenarios where real-time logging to the console is required, such as during development, testing, and production. It supports different formatting options, including log level descriptions, thread information, timestamps, and log messages.

Key Features:

• Customizable log message formats using a pattern.
• Colorized console output to highlight log levels.
• Supports different timestamp formats and timezones.
• Inherits from quill::ConsoleSink for seamless integration with Quill's logging framework.

Note

This class should be used for logging real-time information to the console. It is flexible enough to handle different environments, including testing and production, by adjusting the formatting and log levels.

See also

quill::ConsoleSink

quill::PatternFormatter

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-08-16

Constructor & Destructor Documentation

MRDTConsoleSink()

logging::MRDTConsoleSink::MRDTConsoleSink ( const quill::ConsoleSinkConfig::Colours &  qColors, const quill::ConsoleSinkConfig::ColourMode &  qColorMode, const std::string &  szFormatPattern, const std::string &  szTimeFormat, quill::Timezone  qTimestampTimezone = quill::Timezone::LocalTime, const std::string &  szStream = "stdout"  )

inline

Constructs a new MRDTConsoleSink object with specified formatting and console colors. This constructor initializes the sink with a log message pattern, timestamp format, and optional timezone settings. The constructor also allows customization of the output szStream.

Parameters

qColors	- The console colors configuration for highlighting log levels.
szFormatPattern	- The pattern used to format the log message.
szTimeFormat	- The format of the timestamp in the log message.
qTimestampTimezone	- The timezone used for the timestamp (default: LocalTime).
szStream	- The szStream to output the logs to (default: "stdout").

Note

Ensure that the format pattern and time format are properly defined before using this constructor, as they directly affect the log output structure.

Warning

Incorrect configuration of format patterns or time formats may lead to malformed log outputs.

See also

quill::ConsoleSink

quill::ConsoleSinkConfig

quill::PatternFormatter

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-08-16

                              :
                quill::ConsoleSink(
                    [&]
                    {
                        // Configure ConsoleSinkConfig in a lambda to inline
                        quill::ConsoleSinkConfig qConsoleConfig;
                        qConsoleConfig.set_stream(szStream);
                        qConsoleConfig.set_colour_mode(qColorMode);
                        qConsoleConfig.set_colours(qColors);
                        qConsoleConfig.set_override_pattern_formatter_options(quill::PatternFormatterOptions(szFormatPattern, szTimeFormat, qTimestampTimezone));
                        return qConsoleConfig;
                    }()),
                qFormatter(quill::PatternFormatterOptions(szFormatPattern, szTimeFormat, qTimestampTimezone))    // Pass Parameters into qFormatter type
            {}

Member Function Documentation

write_log()

void logging::MRDTConsoleSink::write_log ( const quill::MacroMetadata *  qLogMetadata, uint64_t  unLogTimestamp, std::string_view  szThreadID, std::string_view  szThreadName, const std::string &  szProcessID, std::string_view  szLoggerName, quill::LogLevel  qLogLevel, std::string_view  szLogLevelDescription, std::string_view  szLogLevelShortCode, const std::vector< std::pair< std::string, std::string > > *  vNamedArgs, std::string_view  szLogMessage, std::string_view    )

override

Writes a log message to the MRDT console sink, formats the message using the provided formatter, and then passes the formatted log message along with the original data to the parent class (ConsoleSink) for handling.

Parameters

qLogMetadata	- Metadata about the log statement (e.g., file, line number).
unLogTimestamp	- The timestamp of the log statement.
szThreadID	- The ID of the thread that generated the log.
szThreadName	- The name of the thread that generated the log.
szProcessID	- The ID of the process that generated the log.
szLoggerName	- The name of the logger that generated the log.
qLogLevel	- The level/severity of the log statement.
szLogLevelDescription	- A description of the log level.
szLogLevelShortCode	- A short code representing the log level.
vNamedArgs	- Optional named arguments passed with the log statement.
szLogMessage	- The actual log message content.

Note

This method calls the base class's write_log function to actually handle the log output, after formatting the message with custom formatting logic.

This method should not be called directly. It is meant to be invoked by the logging framework as part of the log handling process.

See also

quill::ConsoleSink

Warning

Ensure that the formatter is correctly configured before using this method, as improper formatting may lead to incorrect log outputs.

Attention

This method overrides the base class's write_log function to inject custom formatting logic while preserving the core file logging functionality.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-08-16

    {
        // Format the log message
        std::string_view szFormattedLogMessage = qFormatter.format(unLogTimestamp,           // Timestamp
                                                                   szThreadID,               // Thread ID
                                                                   szThreadName,             // Thread name
                                                                   szProcessID,              // Process ID
                                                                   szLoggerName,             // Logger name
                                                                   szLogLevelDescription,    // Log level description
                                                                   szLogLevelShortCode,      // Log level short code
                                                                   *qLogMetadata,            // Log statement metadata
                                                                   vNamedArgs,               // Named arguments
                                                                   szLogMessage              // Log message
        );
 
        // Check if logging level is permitted
        if (static_cast<int>(g_eConsoleLogLevel) <= static_cast<int>(qLogLevel))
        {
            quill::ConsoleSink::write_log(qLogMetadata,             // Metadata
                                          unLogTimestamp,           // Timestamp
                                          szThreadID,               // Thread ID
                                          szThreadName,             // Thread Name
                                          szProcessID,              // Process ID
                                          szLoggerName,             // Logger name
                                          qLogLevel,                // Log level
                                          szLogLevelDescription,    // Log level description
                                          szLogLevelShortCode,      // Log level short code
                                          vNamedArgs,               // Named arguments
                                          szLogMessage,             // Log Message
                                          szFormattedLogMessage     // Formatted Log Message
            );
        }
    }

---

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

• src/AutonomyLogging.h
• src/AutonomyLogging.cpp