optimistic tick alignment for metrics ticker

1 files changed, 15 insertions, 1 deletions

diff --git a/kamon-core/src/main/resources/reference.conf b/kamon-core/src/main/resources/reference.conf
index e0002194..e140db83 100644
--- a/kamon-core/src/main/resources/reference.conf
+++ b/kamon-core/src/main/resources/reference.conf
@@ -1,6 +1,7 @@
 kamon {
 
   environment {
+
     # Identifier for this service.
     service = "kamon-application"
 
@@ -21,9 +22,19 @@ kamon {
   # through Kamon.scheduler()
   scheduler-pool-size = 2
 
+
   metric {
+
+    # Interval at which metric snapshots will be collected and sent to all metric reporters.
     tick-interval = 60 seconds
 
+    # When optimistic tick alignment is enabled the metrics ticker will try to schedule the ticks to happen as close as
+    # possible to round tick-interval units. E.g. if the tick-interval is set to 60 seconds then Kamon will try to
+    # schedule the ticks at the beginning of each minute; if the tick-interval is set to 20 seconds then Kamon will try
+    # to schedule the ticks at 0, 20, and 40 seconds of each minute. The alignment is not meant to be perfect, just to
+    # improve the ability to correlate the timestamp reported in ticks with logs.
+    optimistic-tick-alignment = yes
+
     # Thread pool size used by the metrics refresh scheduler. This pool is only used to periodically sampling
     # min-max-counter values.
     refresh-scheduler-pool-size = 2
@@ -74,6 +85,7 @@ kamon {
     }
   }
 
+
   trace {
 
     # Interval at which sampled finished spans will be flushed to SpanReporters.
@@ -125,6 +137,7 @@ kamon {
     }
   }
 
+
   context {
 
     # Codecs are used to encode/decode Context keys when a Context must be propagated either through HTTP headers or
@@ -148,6 +161,7 @@ kamon {
     }
   }
 
+
   util {
     filters {
 
@@ -155,7 +169,7 @@ kamon {
       # not. E.g. If there are no filter sections for the "jdbc-datasource" category and `accept-unmatched-categories`
       # is set to true, all entities for that category will be accepted, otherwise all will be rejected.
       #
-      # NOTE: Using entity filters is a commodity for modules that might potentially track thousands of unnecessary
+      # NOTE: Using entity fil`ters is a commodity for modules that might potentially track thousands of unnecessary
       #       entities, but not all modules are required to use filters, check the your module's documentation to
       #       determine whether setting up filters make sense or not.
       accept-unmatched = true