add log limit macros

odygrd · Jun 17, 2023 · 0c0cfb5 · 0c0cfb5
1 parent c5bf839
commit 0c0cfb5
Show file tree

Hide file tree

Showing 5 changed files with 198 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
+- [v3.1.0](#v310)
 - [v3.0.2](#v302)
 - [v3.0.1](#v301)
 - [v3.0.0](#v300)
@@ -46,6 +47,18 @@
 - [v1.1.0](#v110)
 - [v1.0.0](#v100)
 
+## v3.1.0
+
+- It is now possible to set a minimum logging interval for specific logs. For example:
+
+```c++
+  for (uint64_t i = 0; i < 10; ++i)
+  {
+    LOG_INFO_LIMIT(2000, default_logger, "log in a loop with limit 1 message every 2000 micros for i {}", i);
+    std::this_thread::sleep_for(std::chrono::microseconds{1000});
+  }
+```
+
 ## v3.0.2
 
 - Add missing header on clang when `QUILL_X86ARCH` is defined.

diff --git a/examples/example_trivial.cpp b/examples/example_trivial.cpp
@@ -1,5 +1,8 @@
 #include "quill/Quill.h"
 
+#include <chrono>
+#include <thread>
+
 /**
  * Trivial logging example
  */
@@ -99,4 +102,11 @@ int main()
   }
 
   LOG_INFO(default_logger, "Existing logger names {}", logger_names);
+
+  for (uint64_t i = 0; i < 10; ++i)
+  {
+    LOG_INFO_LIMIT(2000, default_logger,
+                   "log in a loop with limit 1 message every 2000 micros for i {}", i);
+    std::this_thread::sleep_for(std::chrono::microseconds{1000});
+  }
 }
diff --git a/quill/include/quill/Quill.h b/quill/include/quill/Quill.h
@@ -30,8 +30,8 @@ namespace quill
 
 /** Version Info **/
 constexpr uint32_t VersionMajor{3};
-constexpr uint32_t VersionMinor{0};
-constexpr uint32_t VersionPatch{2};
+constexpr uint32_t VersionMinor{1};
+constexpr uint32_t VersionPatch{0};
 constexpr uint32_t Version{VersionMajor * 10000 + VersionMinor * 100 + VersionPatch};
 
 /** forward declarations **/