odygrd · odygrd · Oct 5, 2024 · Oct 5, 2024 · Oct 5, 2024 · Oct 5, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
+- [v8.0.0](#v800)
 - [v7.5.0](#v750)
 - [v7.4.0](#v740)
 - [v7.3.0](#v730)
@@ -80,6 +81,17 @@
 - [v1.1.0](#v110)
 - [v1.0.0](#v100)
 
+## v8.0.0
+
+- Unified `JsonFileSink.h` and `JsonConsoleSink.h` into a single header, `JsonSink.h`, with both classes now sharing a
+  common implementation
+- Users can now inherit from `JsonFileSink` or `JsonConsoleSink` and override the `generate_json_message(...)` function
+  to implement their own custom JSON log formats
+- Simplified `ConsoleSink` by applying ANSI colour codes universally across all platforms, including Windows. The
+  previous Windows-specific implementation has been removed. Note that `quill::ConsoleColours` has been replaced with
+  `quill::ConsoleSink::Colours`, and `quill::ConsoleColours::ColourMode` has been renamed to
+  `quill::ConsoleSink::ColourMode`.
+
 ## v7.5.0
 
 - In previous versions, logging on Windows automatically included `windows.h` in all components. The frontend will no
@@ -107,7 +119,7 @@
 - Fixed a build issue when compiling with `-fno-rtti`. This ensures compatibility with projects that disable
   `RTTI`. ([#604](https://github.com/odygrd/quill/issues/604))
 - Fixed an incorrectly triggered assertion in debug builds when `BackendOptions::log_timestamp_ordering_grace_period` is
-  set to 0. ([#605](https://github.com/odygrd/quill/issues/605))
+  set to 0 ([#605](https://github.com/odygrd/quill/issues/605))
 - Fixed a compile-time error in `CsvWriter` that occurred when passing a custom `FrontendOptions` type as a template
   parameter. ([#609](https://github.com/odygrd/quill/issues/609))
 - Added accessors to `Logger` for sinks, user clock source, clock source type, and pattern formatter options that can be
@@ -120,6 +132,7 @@
   ```cpp
     quill::Frontend::create_or_get_sink<quill::ConsoleSink>(
       "sink_id_1", quill::ConsoleColours::ColourMode::Automatic);
+   ```
 
 ## v7.3.0
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -216,8 +216,7 @@ set(HEADER_FILES
 
         include/quill/sinks/ConsoleSink.h
         include/quill/sinks/FileSink.h
-        include/quill/sinks/JsonConsoleSink.h
-        include/quill/sinks/JsonFileSink.h
+        include/quill/sinks/JsonSink.h
         include/quill/sinks/NullSink.h
         include/quill/sinks/RotatingFileSink.h
         include/quill/sinks/Sink.h

diff --git a/MODULE.bazel b/MODULE.bazel
@@ -1,6 +1,6 @@
 module(
     name = "quill",
-    version = "7.5.0",
+    version = "8.0.0",
     compatibility_level = 1,
 )
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -35,7 +35,7 @@ def configureDoxyfile(input_dir, output_dir):
 project = 'Quill'
 copyright = '2024, Odysseas Georgoudis'
 author = 'Odysseas Georgoudis'
-release = 'v7.5.0'
+release = 'v8.0.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/json_logging.rst b/docs/json_logging.rst
@@ -18,7 +18,7 @@ Logging Json to Console
     #include "quill/Frontend.h"
     #include "quill/LogMacros.h"
     #include "quill/Logger.h"
-    #include "quill/sinks/JsonConsoleSink.h"
+    #include "quill/sinks/JsonSink.h"
     #include <string>
 
     int main()
@@ -51,7 +51,7 @@ Logging Json to File
     #include "quill/Frontend.h"
     #include "quill/LogMacros.h"
     #include "quill/Logger.h"
-    #include "quill/sinks/JsonFileSink.h"
+    #include "quill/sinks/JsonSink.h"
     #include <string>
 
     int main()
@@ -92,7 +92,7 @@ Combining JSON and Standard Log Patterns
     #include "quill/LogMacros.h"
     #include "quill/Logger.h"
     #include "quill/sinks/ConsoleSink.h"
-    #include "quill/sinks/JsonFileSink.h"
+    #include "quill/sinks/JsonSink.h"
     #include <utility>
 
     int main()

diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -23,6 +23,7 @@ set(EXAMPLE_TARGETS
         quill_example_user_defined_sink
         quill_example_tags_logging
         quill_example_json_console_logging
+        quill_example_json_console_logging_custom_json
         quill_example_csv_writing
         quill_example_json_file_logging
         quill_example_user_defined_types_logging

diff --git a/examples/advanced/quill_wrapper/include/quill_wrapper/quill_wrapper.cpp b/examples/advanced/quill_wrapper/include/quill_wrapper/quill_wrapper.cpp
@@ -17,6 +17,6 @@ void setup_quill(char const* log_file)
   quill::Frontend::create_or_get_logger(
     "root", std::move(console_sink),
     quill::PatternFormatterOptions{"%(time) [%(thread_id)] %(short_source_location:<28) "
-                                        "LOG_%(log_level:<9) %(logger:<12) %(message)",
+                                   "LOG_%(log_level:<9) %(logger:<12) %(message)",
                                    "%H:%M:%S.%Qns", quill::Timezone::GmtTime});
 }
diff --git a/examples/backend_tsc_clock.cpp b/examples/backend_tsc_clock.cpp
@@ -52,7 +52,7 @@ int main()
   auto const tsc_start_seconds = std::chrono::duration_cast<std::chrono::seconds>(
                                    quill::BackendTscClock::to_time_point(tsc_start).time_since_epoch())
                                    .count();
-  
+
   auto const tsc_end_seconds = std::chrono::duration_cast<std::chrono::seconds>(
                                  quill::BackendTscClock::to_time_point(tsc_end).time_since_epoch())
                                  .count();

diff --git a/examples/console_logging.cpp b/examples/console_logging.cpp
@@ -25,7 +25,7 @@ int main()
 
   // Frontend
   auto console_sink = quill::Frontend::create_or_get_sink<quill::ConsoleSink>(
-    "sink_id_1", quill::ConsoleColours::ColourMode::Automatic);
+    "sink_id_1", quill::ConsoleSink::ColourMode::Automatic);
 
   quill::Logger* logger = quill::Frontend::create_or_get_logger("root", std::move(console_sink));
 

diff --git a/examples/custom_console_colours.cpp b/examples/custom_console_colours.cpp
@@ -18,13 +18,12 @@ int main()
   quill::Backend::start(backend_options);
 
   // Frontend
-  quill::ConsoleColours custom_console_colours;
-  custom_console_colours.set_default_colours();
-  custom_console_colours.set_colour(quill::LogLevel::Info, quill::ConsoleColours::blue); // overwrite the colour for INFO
+  quill::ConsoleSink::Colours colours;
+  colours.apply_default_colours();
+  colours.assign_colour_to_log_level(quill::LogLevel::Info, quill::ConsoleSink::Colours::blue); // overwrite the colour for INFO
 
   // Create the sink
-  auto console_sink =
-    quill::Frontend::create_or_get_sink<quill::ConsoleSink>("sink_id_1", custom_console_colours);
+  auto console_sink = quill::Frontend::create_or_get_sink<quill::ConsoleSink>("sink_id_1", colours);
 
   quill::Logger* logger = quill::Frontend::create_or_get_logger("root", std::move(console_sink));
 

diff --git a/examples/file_logging.cpp b/examples/file_logging.cpp
@@ -47,7 +47,7 @@ int main()
   quill::Logger* logger = quill::Frontend::create_or_get_logger(
     "root", std::move(file_sink),
     quill::PatternFormatterOptions{"%(time) [%(thread_id)] %(short_source_location:<28) "
-                                          "LOG_%(log_level:<9) %(logger:<12) %(message)",
+                                   "LOG_%(log_level:<9) %(logger:<12) %(message)",
                                    "%H:%M:%S.%Qns", quill::Timezone::GmtTime});
 
   // set the log level of the logger to debug (default is info)

diff --git a/examples/json_console_logging.cpp b/examples/json_console_logging.cpp
@@ -2,7 +2,7 @@
 #include "quill/Frontend.h"
 #include "quill/LogMacros.h"
 #include "quill/Logger.h"
-#include "quill/sinks/JsonConsoleSink.h"
+#include "quill/sinks/JsonSink.h"
 
 #include <string>
 

diff --git a/examples/json_console_logging_custom_json.cpp b/examples/json_console_logging_custom_json.cpp
@@ -0,0 +1,65 @@
+#include "quill/Backend.h"
+#include "quill/Frontend.h"
+#include "quill/LogMacros.h"
+#include "quill/Logger.h"
+#include "quill/sinks/JsonSink.h"
+
+#include <string>
+
+/**
+ * Overrides generate_json_message to use a custom json format
+ */
+class MyJsonConsoleSink : public quill::JsonConsoleSink
+{
+  void generate_json_message(quill::MacroMetadata const* /** log_metadata **/, uint64_t log_timestamp,
+                             std::string_view /** thread_id **/, std::string_view /** thread_name **/,
+                             std::string const& /** process_id **/, std::string_view /** logger_name **/,
+                             quill::LogLevel /** log_level **/, std::string_view log_level_description,
+                             std::string_view /** log_level_short_code **/,
+                             std::vector<std::pair<std::string, std::string>> const* named_args,
+                             std::string_view /** log_message **/,
+                             std::string_view /** log_statement **/, char const* message_format) override
+  {
+    _json_message.append(fmtquill::format(R"({{"timestamp":"{}","log_level":"{}","message":"{}")",
+                                          std::to_string(log_timestamp), log_level_description, message_format));
+
+    // Add args as key-values
+    if (named_args)
+    {
+      for (auto const& [key, value] : *named_args)
+      {
+        _json_message.append(std::string_view{",\""});
+        _json_message.append(key);
+        _json_message.append(std::string_view{"\":\""});
+        _json_message.append(value);
+        _json_message.append(std::string_view{"\""});
+      }
+    }
+  }
+};
+
+int main()
+{
+  // Start the backend thread
+  quill::BackendOptions backend_options;
+  quill::Backend::start(backend_options);
+
+  // Frontend
+
+  // Create a json sink
+  auto json_sink = quill::Frontend::create_or_get_sink<MyJsonConsoleSink>("json_sink_1");
+
+  // When logging json, it is ideal to set the logging pattern to empty to avoid unnecessary message formatting.
+  quill::Logger* logger = quill::Frontend::create_or_get_logger(
+    "json_logger", std::move(json_sink),
+    quill::PatternFormatterOptions{"", "%H:%M:%S.%Qns", quill::Timezone::GmtTime});
+
+  int var_a = 123;
+  std::string var_b = "test";
+
+  // Log via the convenient LOGJ_ macros
+  LOGJ_INFO(logger, "A json message", var_a, var_b);
+
+  // Or manually specify the desired names of each variable
+  LOG_INFO(logger, "A json message with {var_1} and {var_2}", var_a, var_b);
+}
diff --git a/examples/json_file_logging.cpp b/examples/json_file_logging.cpp
@@ -3,7 +3,7 @@
 #include "quill/LogMacros.h"
 #include "quill/Logger.h"
 #include "quill/sinks/ConsoleSink.h"
-#include "quill/sinks/JsonFileSink.h"
+#include "quill/sinks/JsonSink.h"
 
 #include <utility>
 

diff --git a/examples/recommended_usage/quill_wrapper/include/quill_wrapper/quill_wrapper.cpp b/examples/recommended_usage/quill_wrapper/include/quill_wrapper/quill_wrapper.cpp
@@ -30,6 +30,6 @@ void setup_quill(char const* log_file)
   global_logger_a = quill::Frontend::create_or_get_logger(
     "root", std::move(file_sink),
     quill::PatternFormatterOptions{"%(time) [%(thread_id)] %(short_source_location:<28) "
-                                          "LOG_%(log_level:<9) %(logger:<12) %(message)",
+                                   "LOG_%(log_level:<9) %(logger:<12) %(message)",
                                    "%H:%M:%S.%Qns", quill::Timezone::GmtTime});
 }
diff --git a/examples/rotating_file_logging.cpp b/examples/rotating_file_logging.cpp
@@ -34,7 +34,7 @@ int main()
   quill::Logger* logger = quill::Frontend::create_or_get_logger(
     "root", std::move(rotating_file_sink),
     quill::PatternFormatterOptions{"%(time) [%(thread_id)] %(short_source_location:<28) "
-                                          "LOG_%(log_level:<9) %(logger:<12) %(message)",
+                                   "LOG_%(log_level:<9) %(logger:<12) %(message)",
                                    "%H:%M:%S.%Qns", quill::Timezone::GmtTime});
 
   for (int i = 0; i < 20; ++i)

diff --git a/examples/shared_library/example_shared.cpp b/examples/shared_library/example_shared.cpp
@@ -24,8 +24,8 @@ int main()
   // Change the LogLevel to print everything
   global_logger_a->set_log_level(quill::LogLevel::TraceL3);
 
-  std::string s {"string"};
-  std::string_view sv {"string_view"};
+  std::string s{"string"};
+  std::string_view sv{"string_view"};
 
   LOG_TRACE_L3(global_logger_a, "This is a log trace l3 example {}", 1);
   LOG_TRACE_L2(global_logger_a, "This is a log trace l2 example {} {}", 2, 2.3);

diff --git a/...shared_library/quill_wrapper_shared/include/quill_wrapper_shared/quill_wrapper_shared.cpp b/...shared_library/quill_wrapper_shared/include/quill_wrapper_shared/quill_wrapper_shared.cpp
@@ -20,6 +20,6 @@ void setup_quill()
   global_logger_a = quill::Frontend::create_or_get_logger(
     "root", std::move(console_sink),
     quill::PatternFormatterOptions{"%(time) [%(thread_id)] %(short_source_location:<28) "
-                                          "LOG_%(log_level:<9) %(logger:<12) %(message)",
+                                   "LOG_%(log_level:<9) %(logger:<12) %(message)",
                                    "%H:%M:%S.%Qns", quill::Timezone::GmtTime});
 }
diff --git a/examples/signal_handler.cpp b/examples/signal_handler.cpp
@@ -76,7 +76,7 @@ int main()
         }
 
         // After 10 messages Crash - Uncomment any of the below :
-        
+
         // illegal_instruction(logger);
         // cause_segfault(logger);
       });

diff --git a/examples/single_logger_multiple_sink_formats/ConsoleSinkWithFormatter.h b/examples/single_logger_multiple_sink_formats/ConsoleSinkWithFormatter.h
@@ -13,8 +13,9 @@ class ConsoleSinkWithFormatter : public quill::ConsoleSink
 {
 public:
   ConsoleSinkWithFormatter(quill::PatternFormatterOptions const& pattern_formater_options,
-                           bool enable_colours = true, std::string const& stream = "stdout")
-    : quill::ConsoleSink(enable_colours, stream), _formatter(pattern_formater_options)
+                           quill::ConsoleSink::ColourMode colour_mode = quill::ConsoleSink::ColourMode::Automatic,
+                           std::string const& stream = "stdout")
+    : quill::ConsoleSink(colour_mode, stream), _formatter(pattern_formater_options)
   {
   }
 

diff --git a/examples/single_logger_multiple_sink_formats/RotatingFileSinkWithFormatter.h b/examples/single_logger_multiple_sink_formats/RotatingFileSinkWithFormatter.h
@@ -19,18 +19,19 @@ class RotatingFileSinkWithFormatter : public quill::RotatingFileSink
   {
   }
 
-  void write_log(quill::MacroMetadata const* log_metadata, uint64_t log_timestamp, std::string_view thread_id,
-                                     std::string_view thread_name, std::string const& process_id,
-                                     std::string_view logger_name, quill::LogLevel log_level,
+  void write_log(quill::MacroMetadata const* log_metadata, uint64_t log_timestamp,
+                 std::string_view thread_id, std::string_view thread_name,
+                 std::string const& process_id, std::string_view logger_name, quill::LogLevel log_level,
                  std::string_view log_level_description, std::string_view log_level_short_code,
                  std::vector<std::pair<std::string, std::string>> const* named_args,
-                                     std::string_view log_message, std::string_view) override
+                 std::string_view log_message, std::string_view) override
   {
     std::string_view const formatted_log_statement =
       _formatter.format(log_timestamp, thread_id, thread_name, process_id, logger_name, log_level_description,
                         log_level_short_code, *log_metadata, named_args, log_message);
 
-    quill::RotatingFileSink::write_log(log_metadata, log_timestamp, thread_id, thread_name, process_id, logger_name, log_level,
+    quill::RotatingFileSink::write_log(
+      log_metadata, log_timestamp, thread_id, thread_name, process_id, logger_name, log_level,
       log_level_description, log_level_short_code, named_args, log_message, formatted_log_statement);
   }
 

diff --git a/examples/user_defined_filter.cpp b/examples/user_defined_filter.cpp
@@ -19,7 +19,7 @@
 class UserFilter : public quill::Filter
 {
 public:
-  UserFilter() : quill::Filter("filter_1"){};
+  UserFilter() : quill::Filter("filter_1") {};
 
   bool filter(quill::MacroMetadata const* /** log_metadata **/, uint64_t /** log_timestamp **/,
               std::string_view /** thread_id **/, std::string_view /** thread_name **/,

diff --git a/examples/user_defined_types_logging.cpp b/examples/user_defined_types_logging.cpp
@@ -2,6 +2,7 @@
 #include "quill/Frontend.h"
 #include "quill/LogMacros.h"
 #include "quill/Logger.h"
+#include "quill/bundled/fmt/ostream.h"
 #include "quill/sinks/ConsoleSink.h"
 
 #include <cstdint>
@@ -24,7 +25,7 @@ class User
 {
 public:
   User(std::string name, std::string surname, uint32_t age)
-    : name(std::move(name)), surname(std::move(surname)), age(age){};
+    : name(std::move(name)), surname(std::move(surname)), age(age) {};
 
   friend std::ostream& operator<<(std::ostream& os, User const& obj)
   {

diff --git a/include/quill/Backend.h b/include/quill/Backend.h
@@ -22,8 +22,8 @@
 QUILL_BEGIN_NAMESPACE
 
 /** Version Info - When updating VersionMajor please also update the namespace in Attributes.h **/
-constexpr uint32_t VersionMajor{7};
-constexpr uint32_t VersionMinor{5};
+constexpr uint32_t VersionMajor{8};
+constexpr uint32_t VersionMinor{0};
 constexpr uint32_t VersionPatch{0};
 constexpr uint32_t Version{VersionMajor * 10000 + VersionMinor * 100 + VersionPatch};
 
@@ -113,21 +113,6 @@ class Backend
                    });
   }
 
-  /***/
-  template <typename TFrontendOptions>
-  [[deprecated(
-    "This function is deprecated and will be removed in the next version. Use "
-    "start(BackendOptions, SignalHandlerOptions) instead ")]] QUILL_ATTRIBUTE_COLD static void
-  start_with_signal_handler(BackendOptions const& options = BackendOptions{},
-                            QUILL_MAYBE_UNUSED std::initializer_list<int> const& catchable_signals =
-                              std::initializer_list<int>{SIGTERM, SIGINT, SIGABRT, SIGFPE, SIGILL, SIGSEGV},
-                            uint32_t signal_handler_timeout_seconds = 20u,
-                            std::string const& signal_handler_logger = {})
-  {
-    SignalHandlerOptions sho{catchable_signals, signal_handler_timeout_seconds, signal_handler_logger};
-    start<TFrontendOptions>(options, sho);
-  }
-
   /**
    * Stops the backend thread.
    * @note thread-safe