Soralog is a high-performance, flexible logging library designed for C++ applications. It provides robust logging features, supports multiple logging backends, and allows extensive customization. The library is designed to be lightweight, efficient, and easy to integrate into various projects.

• Multiple log sinks: console, file, syslog, and more.
• Efficient lock-free circular buffer for log messages.
• Thread-safe logging with minimal overhead.
• Hierarchical logging groups with inheritance.
• Configurable log levels and formats.
• Configurable via YAML or programmatically.
• Macro-based or object-based logging interface (up to user).

Soralog requires:

• fmt for formatting log messages.
• yaml-cpp for convenient configuring.
• gtest for unit tests (optional).

Soralog uses CMake as its build system and supports different configurations through CMake options.

• BUILD_TESTS (default: OFF) – Build unit tests.
• EXAMPLES (default: OFF) – Build example programs.
• ASAN, LSAN, MSAN, TSAN, UBSAN (default: OFF) – Enable sanitizers.

Soralog supports dependency management via hunter and vcpkg. By default, hunter is used unless a vcpkg toolchain file is detected.

git clone https://github.com/xDimon/soralog.git
cd soralog
mkdir build && cd build
cmake .. -DBUILD_TESTS=ON -DEXAMPLES=ON
make

To use vcpkg, specify the toolchain file:

cmake -DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg.cmake ..

To include Soralog in your project, add the following to your CMakeLists.txt:

find_package(soralog REQUIRED)
target_link_libraries(your_project PRIVATE soralog)

    LoggingSystem logging_system(configurator); // See examples
    soralog::Logger logger = logging_system.getLogger("loggger", "main_group");
}

    logger.debug("Hello, {}!", "world");
    logger.info("Hello, {}!", "world");

    SL_INFO(logger, "Hello, {}!", "world");
    SL_WARN(logger, "Hello, {}!", "world");

Soralog uses a YAML-based configuration file. Below is a detailed breakdown of all available parameters.

sinks:
  - name: colored_stdout
    type: console
    stream: stdout
    color: true

  - name: file
    type: file
    path: /tmp/soralog.log

groups:
  - name: main
    sink: colored_stdout
    level: trace
    is_fallback: true
    children:
      - name: example_group

Soralog provides various examples demonstrating different use cases and configurations. Below is a list of available examples:

1. 01-hello_world – A minimal example that initializes a logger and writes a simple message.
2. 02-manual – Demonstrates programmatic configuration of logging without using a YAML config file.
3. 03-with_config_file – Shows how to configure Soralog using a YAML configuration file.
4. 04-cascade_config – Demonstrates hierarchical logging groups with inherited settings.
5. 05-two_sinks – Example of logging to two different sinks (e.g., console and file).
6. 06-multisink – Uses a multisink to send log messages to multiple destinations.
7. 07-multisink_with_different_level – Extends the multisink example by setting different log levels for different sinks.
8. 99-most_features – A comprehensive example showcasing most of Soralog’s features, including advanced configuration, multi-threading, and custom loggers.

The source code for these examples is available in the example directory.

Soralog is utilized in several open-source projects, including:

• cpp-libp2p
• Kagome
• cpp-jam

We welcome contributions! Feel free to submit issues and pull requests.

Soralog is licensed under the Apache-2.0 license. See the LICENSE file for details.