= statsd: reference.conf file explanatory comments

1 files changed, 15 insertions, 1 deletions

diff --git a/kamon-statsd/src/main/resources/reference.conf b/kamon-statsd/src/main/resources/reference.conf
index da103338..f5253218 100644
--- a/kamon-statsd/src/main/resources/reference.conf
+++ b/kamon-statsd/src/main/resources/reference.conf
@@ -4,16 +4,30 @@
 
 kamon {
   statsd {
-    hostname = "10.254.169.44"
+    # Hostname and port in which your StatsD is running. The hostname setting has been intentionally preset with
+    # a config parser breaking value (127.0.0.1 should be inside quotes to work correctly) in order to force users
+    # to review the configuration and set correct values. Remember that StatsD packets are sent using UDP and
+    # using unreachable hosts or not open ports wont be warned by the Kamon., your data wont go anywhere.
+    hostname = 127.0.0.1
     port = 8125
+
+    # Interval between metrics data flushes to StatsD. It's value must be equal or greater than the
+    # kamon.metrics.tick-interval setting.
     flush-interval = 1 second
+
+    # Max packet size in bytes for UDP metrics data sent to StatsD.
     max-packet-size = 1024
 
+    # Subscription patterns used to select which metrics will be pushed to StatsD. Note that first, metrics
+    # collection for your desired entities must be activated under the kamon.metrics.filters settings.
     includes {
       actor = [ "*" ]
     }
 
     simple-metric-key-generator {
+      # Application prefix for all metrics pushed to StatsD. The default namespacing scheme for metrics follows
+      # this pattern:
+      #    application.host.entity.entity-name.metric-name
       application = "Kamon"
     }
   }