]> arthur.barton.de Git - netdata.git/commitdiff
updated info
authorCosta Tsaousis (ktsaou) <costa@tsaousis.gr>
Wed, 22 Feb 2017 22:52:05 +0000 (00:52 +0200)
committerCosta Tsaousis (ktsaou) <costa@tsaousis.gr>
Wed, 22 Feb 2017 22:52:05 +0000 (00:52 +0200)
conf.d/aggregated_hosts.conf

index 7dd5eaa0db7c773d6f23ff5dea549877bcc299db..233c4ea5f346213c125b79cdd15e7f41366b0b79 100644 (file)
@@ -1,31 +1,58 @@
 # netdata configuration for aggregating data from remote hosts
 #
-# 1. You need an API key: API_KEY_GENERATED_BY_UUIDGEN
+# -----------------------------------------------------------------------------
+# 1. SLAVE NETDATA - THE ONE THAT WILL BE SENDING METRICS
+#
+#    In /etc/netdata/netdata.conf you have a configuration like this:
+#
+#    [stream]
+#
+#        # enable or disable sending metrics.
+#        # default: no
+#           enabled = yes
+#
+#        # when set to yes, the slave netdata will not start
+#        # its web server and will not maintain a database.
+#        # when set to yes, the slave netdata will be just a metrics collector.
+#        # default: yes
+#           exclusive = yes
+#
+#        # one or more netdata hosts to send metrics to.
+#        # only one will get them, the first available.
+#           stream metrics to = HOST1:PORT1 HOST2:PORT2 ...
+#
+#        # the API key to use, to authorize ourselves
+#           api key =  API_KEY_GENERATED_BY_UUIDGEN
+#
+# -----------------------------------------------------------------------------
+# 2. MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
+#
+#    You need an API key: API_KEY_GENERATED_BY_UUIDGEN
+#    This key should be specified at the master and the slave netdata servers.
 #
 #    You can generate one with the command: uuidgen
-#    You can add many API key sections, for different API keys
+#    You can add many API key sections below, for each API key.
+#
+#    You can have one API key per slave, or the same API key for all slaves.
+#    Each slave will automatically create its own virtual host at the master
+#    even if all slaves use the same API key.
 #
-# 2. All options below are used in this order:
+#    All options below are used 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)
 #
-#    You can combine the above (the more specific will be used).
-#
-# 3. At the remote host that will be sending metrics, you need
-#    to add in netdata.conf, the following:
-#
-#    [global]
-#        central netdata to send all data = 10.11.12.1:19999
-#        central netdata api key = API_KEY_GENERATED_BY_UUIDGEN
-#
-#    Of course, the same API_KEY_GENERATED_BY_UUIDGEN key must
-#    given there (the remote host) and here (the central netdata).
+#    You can combine the above (the more specific setting will be used).
 #
 # -----------------------------------------------------------------------------
 
+# API key authentication
+# If the key is not listed here, it will not be able to connect.
+
 [API_KEY_GENERATED_BY_UUIDGEN]
+    # 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
 #    enabled = yes
@@ -39,7 +66,8 @@
     # The default memory mode to be used for all hosts using this API key.
     # You can also set it per host below.
     # If you don't set it here, the memory mode of the central netdata
-    # will be used
+    # will be used.
+    # Valid modes: save (load/save db), map (like swap), ram (no disk)
 #    default memory mode = save
 
     # Shall we enable health monitoring for the hosts using this API key?