Wrapper function for the common rate-limited-log pattern.

1 files changed, 9 insertions, 0 deletions

diff --git a/src/common/util.h b/src/common/util.h
index fabfdb19f..005a3f37c 100644
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -284,6 +284,15 @@ void update_approx_time(time_t now);
       }
     }
    </pre>
+
+   As a convenience wrapper for logging, you can replace the above with:
+   <pre>
+   if (possibly_very_frequent_event()) {
+     static ratelim_t warning_limit = RATELIM_INIT(300);
+     log_fn_ratelim(&warning_limit, LOG_WARN, LD_GENERAL,
+                    "The event occurred!");
+   }
+   </pre>
  */
 typedef struct ratelim_t {
   int rate;