SimpleLogger

SimpleLogger is a simple C++ logging library designed for easy integration into your projects. It offers flexibility in logging levels, multiple output streams, thread-safety, and configuration options.

Install

Git Submodules

1. Download the library as a submodule:

   git submodule add [email protected]:PlungedInCode/SimpleLogger.git lib

   or clone the repository directly:

   git clone [email protected]:PlungedInCode/SimpleLogger.git

2. Update submodules

   git submodule update --init --recursive

3. Integrate it into your CMake project:

   add_subdirectory(lib/SimpleLogger)
   target_link_libraries(your_project SimpleLogger)

Building and runing examples:

 mkdir build && cd build
 cmake ..
 make
 example/example

Getting Started

Include the header in your C++ file:

#include "Logger.hpp"

Then, initialize the logger level (by default, it's kInfo) and start logging:

int main() {
    Logger::SetLogLevel(LogLevel::kDebug);
    LOG_DEBUG("Hello, SimpleLogger!");
    return 0;
}

Levels

SimpleLogger supports the following log levels:

• TRACE
• DEBUG
• INFO
• WARNING
• ERROR

Use these levels to control the verbosity of your logs.

Usage Samples

Basic Usage

#include "Logger.hpp"

int main() {
    LOG_TRACE("This is a trace message.");
    LOG_DEBUG("This is a debug message.");
    LOG_INFO("This is an info message.");
    LOG_WARNING("This is a warning message.");
    LOG_ERROR("This is an error message.");
    return 0;
}

Time Stamps

Enable time stamps for log entries:

Logger::EnableTimeStamp();
LOG_INFO("Log entry with timestamp.");
Logger::DisableTimeStamp();

File Stamp

Enable file stamps (file and line number) for log entries:

Logger::EnableFileStamp();
LOG_INFO("Log entry with line stamp.");
Logger::DisableFileStamp();

File/Console Logging

There are three types of logging(by default, type is kConsole ):

• File
• Console
• Both

Logger::SetStream(OutputStream::kBoth);
Logger::SetLogFile("MyLogs.txt");
LOG_INFO("Log entry to file.");

Contribution

Feel free to contribute to SimpleLogger by submitting issues or pull requests.

TODO

• Log Formatting Logger::SetLogFormat("[{timestamp}] [{level}] {message}");
• Log Rotation
• Stream Logging
• Contextual Logging
• Time Controller for Debugging
• Log Tagging
• Conditional Logging
• Asynchronous Logging