New upstream version 1.7.0+dfsgupstream/1.7.0+dfsg

1 files changed, 51 insertions, 44 deletions

diff --git a/conf.d/stream.conf b/conf.d/stream.conf
index 0ebdccb8..0ae5ba67 100644
--- a/conf.d/stream.conf
+++ b/conf.d/stream.conf
@@ -5,59 +5,64 @@
 # number of hosts.
 #
 # You can generate API keys, with the linux command: uuidgen
-#
+
+
 # -----------------------------------------------------------------------------
 # 1. ON SLAVE NETDATA - THE ONE THAT WILL BE SENDING METRICS
 
 [stream]
     # Enable this on slaves, to have them send metrics.
-	enabled = no
-
-	# The destination to send metrics to.
-	# A space separated list of:
-	#         [PROTOCOL:]HOST[%INTERFACE][:PORT]
-	# The first available will get the metrics.
-	# PROTOCOL = tcp or udp (only tcp is supported by masters)
-	# HOST = an IPv4, IPv6 IP, or a hostname.
-	#        IPv6 IPs should be given with brackets [ip:address]
-	# INTERFACE = the network interface to use
-	# PORT = the port number or service name (/etc/services)
-	# This communication is not HTTP (cannot be proxied by web proxies).
-	destination =
-
-	# The API_KEY to use (as the sender)
-	api key =
+    enabled = no
+
+    # Where is the receiving netdata?
+    # A space separated list of:
+    #
+    #      [PROTOCOL:]HOST[%INTERFACE][:PORT]
+    #
+    # If many are given, the first available will get the metrics.
+    #
+    # PROTOCOL  = tcp or udp (only tcp is supported by masters)
+    # HOST      = an IPv4, IPv6 IP, or a hostname.
+    #             IPv6 IPs should be given with brackets [ip:address]
+    # INTERFACE = the network interface to use
+    # PORT      = the port number or service name (/etc/services)
+    #
+    # This communication is not HTTP (cannot be proxied by web proxies).
+    destination =
+
+    # The API_KEY to use (as the sender)
+    api key =
 
     # The timeout to connect and send metrics
-	timeout seconds = 60
+    timeout seconds = 60
 
-	# If the destination line above does specify a port, use this
-	default port = 19999
+    # If the destination line above does not specify a port, use this
+    default port = 19999
 
-	# The buffer to use for sending metrics.
-	# 1MB by default is good for 2-3 seconds of data, so increase this
-	# if you expect latencies.
-	buffer size bytes = 1048576
+    # The buffer to use for sending metrics.
+    # 1MB is good for 10-20 seconds of data, so increase this
+    # if you expect latencies.
+    buffer size bytes = 1048576
 
-	# If the connection fails, or it disconnects,
-	# retry after that many seconds.
-	reconnect delay seconds = 5
+    # If the connection fails, or it disconnects,
+    # retry after that many seconds.
+    reconnect delay seconds = 5
 
-	# Attempt to sync the clock the of the master with the clock of the
-	# slave for that many iterations, when starting.
-	initial clock resync iterations = 60
+    # Attempt to sync the clock the of the master with the clock of the
+    # slave for that many iterations, when starting.
+    initial clock resync iterations = 60
 
 
 # -----------------------------------------------------------------------------
 # 2. ON MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
-#
+
 #    You can have one API key per slave, or the same API key for all slaves.
 #
-#    All options below are used in this order:
+#    netdata searches for options in this order:
 #
-#    a) MACHINE_GUID (settings for each machine)
-#    b) API_KEY      (settings for the API key)
-#    c) this netdata defaults (as in netdata.conf)
+#    a) [MACHINE_GUID] section  (settings for each machine)
+#    b) [API_KEY] section       (settings for the API key)
+#    c) master netdata settings (netdata.conf)
 #
 #    You can combine the above (the more specific setting will be used).
 
@@ -68,13 +73,13 @@
     # Default settings for the API key
 
     # You can disable the API key, by setting this to: no
-    # The default (for unknown API keys) is also: no
+    # The default (for unknown API keys) is: no
     enabled = no
 
     # The default history in entries, for all hosts using this API key.
     # You can also set it per host below.
     # If you don't set it here, the history size of the central netdata
-    # will be used
+    # will be used.
     default history = 3600
 
     # The default memory mode to be used for all hosts using this API key.
@@ -84,11 +89,11 @@
     #    save    save on exit, load on start
     #    map     like swap (continuously syncing to disks)
     #    ram     keep it in RAM, don't touch the disk
-    #    none    no database (passing through this netdata)
+    #    none    no database at all (use this on headless proxies)
     default memory mode = ram
 
     # Shall we enable health monitoring for the hosts using this API key?
-    # 3 values:
+    # 3 possible values:
     #    yes     enable alarms
     #    no      do not enable alarms
     #    auto    enable alarms, only when the sending netdata is connected
@@ -107,16 +112,18 @@
 
 
 # -----------------------------------------------------------------------------
-# 3. ON MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
-#
-# THIS IS OPTIONAL - YOU DON'T NEED IT BY DEFAULT
-# It only exists to give you finer control of the master settings for each
+# 3. PER SENDING HOST SETTINGS, ON MASTER NETDATA
+#    THIS IS OPTIONAL - YOU DON'T NEED IT
+
+# This section exists to give you finer control of the master settings for each
 # slave host, when the same API key is used by many netdata slaves / proxies.
 #
 # Each netdata has a unique GUID - generated the first time netdata starts.
 # You can find it at /var/lib/netdata/registry/netdata.public.unique.id
+# (at the slave).
+#
 # The host sending data will have one. If the host is not ephemeral,
-# you can give settings for each specific host here.
+# you can give settings for each sending host here.
 
 [MACHINE_GUID]
     # enable this host: yes | no