beautification of comments
Costa Tsaousis (ktsaou) committed
Apr 11, 2017 at 23:31 UTC
53d2bb0f2e538c13436a2d56c987a89b13fa3ce8
1 file changed
+51
-44
conf.d/stream.conf
+51
-44
@@ -5,59 +5,64 @@
5
# number of hosts.
6
#
7
# You can generate API keys, with the linux command: uuidgen
8
-#
8
+
9
+
10
# -----------------------------------------------------------------------------
11
# 1. ON SLAVE NETDATA - THE ONE THAT WILL BE SENDING METRICS
12
13
[stream]
14
# Enable this on slaves, to have them send metrics.
14
- enabled = no
15
-
16
- # The destination to send metrics to.
17
- # A space separated list of:
18
- # [PROTOCOL:]HOST[%INTERFACE][:PORT]
19
- # The first available will get the metrics.
20
- # PROTOCOL = tcp or udp (only tcp is supported by masters)
21
- # HOST = an IPv4, IPv6 IP, or a hostname.
22
- # IPv6 IPs should be given with brackets [ip:address]
23
- # INTERFACE = the network interface to use
24
- # PORT = the port number or service name (/etc/services)
25
- # This communication is not HTTP (cannot be proxied by web proxies).
26
- destination =
27
-
28
- # The API_KEY to use (as the sender)
29
- api key =
15
+ enabled = no
16
+
17
+ # Where is the receiving netdata?
18
+ # A space separated list of:
19
+ #
20
+ # [PROTOCOL:]HOST[%INTERFACE][:PORT]
21
+ #
22
+ # If many are given, the first available will get the metrics.
23
+ #
24
+ # PROTOCOL = tcp or udp (only tcp is supported by masters)
25
+ # HOST = an IPv4, IPv6 IP, or a hostname.
26
+ # IPv6 IPs should be given with brackets [ip:address]
27
+ # INTERFACE = the network interface to use
28
+ # PORT = the port number or service name (/etc/services)
29
+ #
30
+ # This communication is not HTTP (cannot be proxied by web proxies).
31
+ destination =
32
+
33
+ # The API_KEY to use (as the sender)
34
+ api key =
35
36
# The timeout to connect and send metrics
32
- timeout seconds = 60
37
+ timeout seconds = 60
38
34
- # If the destination line above does not specify a port, use this
35
- default port = 19999
39
+ # If the destination line above does not specify a port, use this
40
+ default port = 19999
41
37
- # The buffer to use for sending metrics.
38
- # 1MB by default is good for 2-3 seconds of data, so increase this
39
- # if you expect latencies.
40
- buffer size bytes = 1048576
42
+ # The buffer to use for sending metrics.
43
+ # 1MB is good for 10-20 seconds of data, so increase this
44
+ # if you expect latencies.
45
+ buffer size bytes = 1048576
46
42
- # If the connection fails, or it disconnects,
43
- # retry after that many seconds.
44
- reconnect delay seconds = 5
47
+ # If the connection fails, or it disconnects,
48
+ # retry after that many seconds.
49
+ reconnect delay seconds = 5
50
46
- # Attempt to sync the clock the of the master with the clock of the
47
- # slave for that many iterations, when starting.
48
- initial clock resync iterations = 60
51
+ # Attempt to sync the clock the of the master with the clock of the
52
+ # slave for that many iterations, when starting.
53
+ initial clock resync iterations = 60
54
55
56
# -----------------------------------------------------------------------------
57
# 2. ON MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
53
-#
58
+
59
# You can have one API key per slave, or the same API key for all slaves.
60
#
56
-# All options below are used in this order:
61
+# netdata searches for options in this order:
62
#
58
-# a) MACHINE_GUID (settings for each machine)
59
-# b) API_KEY (settings for the API key)
60
-# c) this netdata defaults (as in netdata.conf)
63
+# a) [MACHINE_GUID] section (settings for each machine)
64
+# b) [API_KEY] section (settings for the API key)
65
+# c) master netdata settings (netdata.conf)
66
#
67
# You can combine the above (the more specific setting will be used).
68
@@ -68,13 +73,13 @@
73
# Default settings for the API key
74
75
# You can disable the API key, by setting this to: no
71
- # The default (for unknown API keys) is also: no
76
+ # The default (for unknown API keys) is: no
77
enabled = no
78
79
# The default history in entries, for all hosts using this API key.
80
# You can also set it per host below.
81
# If you don't set it here, the history size of the central netdata
77
- # will be used
82
+ # will be used.
83
default history = 3600
84
85
# The default memory mode to be used for all hosts using this API key.
@@ -84,11 +89,11 @@
89
# save save on exit, load on start
90
# map like swap (continuously syncing to disks)
91
# ram keep it in RAM, don't touch the disk
87
- # none no database (passing through this netdata)
92
+ # none no database at all (use this on headless proxies)
93
default memory mode = ram
94
95
# Shall we enable health monitoring for the hosts using this API key?
91
- # 3 values:
96
+ # 3 possible values:
97
# yes enable alarms
98
# no do not enable alarms
99
# auto enable alarms, only when the sending netdata is connected
@@ -107,16 +112,18 @@
112
113
114
# -----------------------------------------------------------------------------
110
-# 3. ON MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
111
-#
112
-# THIS IS OPTIONAL - YOU DON'T NEED IT BY DEFAULT
113
-# It only exists to give you finer control of the master settings for each
115
+# 3. PER SENDING HOST SETTINGS, ON MASTER NETDATA
116
+# THIS IS OPTIONAL - YOU DON'T NEED IT
117
+
118
+# This section exists to give you finer control of the master settings for each
119
# slave host, when the same API key is used by many netdata slaves / proxies.
120
#
121
# Each netdata has a unique GUID - generated the first time netdata starts.
122
# You can find it at /var/lib/netdata/registry/netdata.public.unique.id
123
+# (at the slave).
124
+#
125
# The host sending data will have one. If the host is not ephemeral,
119
-# you can give settings for each specific host here.
126
+# you can give settings for each sending host here.
127
128
[MACHINE_GUID]
129
# enable this host: yes | no