Merge branch 'wip/simple-tracing-implementation'

1 files changed, 44 insertions, 0 deletions

diff --git a/kamon-core/src/main/resources/reference.conf b/kamon-core/src/main/resources/reference.conf
index 639d4aba..7c4b4ecb 100644
--- a/kamon-core/src/main/resources/reference.conf
+++ b/kamon-core/src/main/resources/reference.conf
@@ -127,6 +127,50 @@ kamon {
 
   trace {
 
+    # Level of detail used when recording trace information. The posible values are:
+    #  - metrics-only: metrics for all included traces and all segments are recorded, but no Trace messages will be sent
+    #    to the subscriptors of trace data.
+    #  - simple-trace: metrics for all included traces and all segments are recorded and additionally a Trace message
+    #    containing the trace and segments details and metadata.
+    level = metrics-only
+
+    # Sampling strategy to apply when the tracing level is set to `simple-trace`. The options are: all, random, ordered
+    # and threshold. The details of each sampler are bellow.
+    sampling = random
+
+    # Use a ThreadLocalRandom to generate numbers between 1 and 100, if the random number is less or equal to .chance
+    # then tracing information will be gathered and reported for the current trace.
+    random-sampler {
+      chance = 10
+    }
+
+    # Use a AtomicLong to ensure that every .sample-interval number of requests tracing information will be gathered and
+    # reported.
+    ordered-sampler {
+      sample-interval = 10
+    }
+
+    # Gather tracing information for all traces but only report those whose elapsed-time is equal or greated to the
+    # .minimum-elapsed-time setting.
+    threshold-sampler {
+      threshold = 1 second
+    }
+
+    incubator {
+      # Minimum time to stay in the trace incubator before checking if the trace should not be incubated anymore. No
+      # checks are made at least until this period has passed.
+      min-incubation-time = 5 seconds
+
+      # Time to wait between incubation checks. After min-incubation-time, a trace is checked using this interval and if
+      # if shouldn't be incubated anymore, the TraceInfo is collected and reported for it.
+      check-interval = 1 second
+
+      # Max amount of time that a trace can be in the incubator. If this time is reached for a given trace then it will
+      # be reported with whatever information is available at the moment, logging a warning for each segment that remains
+      # open after this point.
+      max-incubation-time = 20 seconds
+    }
+
     # If ask-pattern-tracing is enabled, a WARN level log message will be generated if a future generated by the `ask`
     # pattern fails with a `AskTimeoutException` and the log message will contain a stack trace captured at the moment
     # the future was created.