1 # netdata configuration for aggregating data from remote hosts
3 # API keys authorize a pair of sending-receiving netdata servers.
4 # Once their communication is authorized, they can exchange metrics for any
7 # You can generate API keys, with the linux command: uuidgen
9 # -----------------------------------------------------------------------------
10 # 1. ON SLAVE NETDATA - THE ONE THAT WILL BE SENDING METRICS
13 # Enable this on slaves, to have them send metrics.
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).
28 # The API_KEY to use (as the sender)
31 # The timeout to connect and send metrics
34 # If the destination line above does specify a port, use this
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 # If the connection fails, or it disconnects,
43 # retry after that many seconds.
44 reconnect delay seconds = 5
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 # -----------------------------------------------------------------------------
52 # 2. ON MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
54 # You can have one API key per slave, or the same API key for all slaves.
56 # All options below are used in this order:
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)
62 # You can combine the above (the more specific setting will be used).
64 # API key authentication
65 # If the key is not listed here, it will not be able to connect.
68 # Default settings for the API key
70 # You can disable the API key, by setting this to: no
71 # The default (for unknown API keys) is also: no
74 # The default history in entries, for all hosts using this API key.
75 # You can also set it per host below.
76 # If you don't set it here, the history size of the central netdata
78 default history = 3600
80 # The default memory mode to be used for all hosts using this API key.
81 # You can also set it per host below.
82 # If you don't set it here, the memory mode of netdata.conf will be used.
84 # save save on exit, load on start
85 # map like swap (continuously syncing to disks)
86 # ram keep it in RAM, don't touch the disk
87 # none no database (passing through this netdata)
88 default memory mode = ram
90 # Shall we enable health monitoring for the hosts using this API key?
93 # no do not enable alarms
94 # auto enable alarms, only when the sending netdata is connected
95 # You can also set it per host, below.
96 # The default is the same as to netdata.conf
97 health enabled by default = auto
99 # postpone alarms for a short period after the sender is connected
100 default postpone alarms on connect seconds = 60
102 # need to route metrics differently? set these.
103 # the defaults are the ones at the [stream] section
104 #default proxy enabled = yes | no
105 #default proxy destination = IP:PORT IP:PORT ...
106 #default proxy api key = API_KEY
109 # -----------------------------------------------------------------------------
110 # 3. ON MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
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
114 # slave host, when the same API key is used by many netdata slaves / proxies.
116 # Each netdata has a unique GUID - generated the first time netdata starts.
117 # You can find it at /var/lib/netdata/registry/netdata.public.unique.id
118 # The host sending data will have one. If the host is not ephemeral,
119 # you can give settings for each specific host here.
122 # enable this host: yes | no
123 # When disabled, the master will not receive metrics for this host.
124 # THIS IS NOT A SECURITY MECHANISM - AN ATTACKER CAN SET ANY OTHER GUID.
125 # Use only the API key for security.
128 # The number of entries in the database
131 # The memory mode of the database: save | map | ram | none
134 # Health / alarms control: yes | no | auto
137 # postpone alarms when the sender connects
138 postpone alarms on connect seconds = 60
140 # need to route metrics differently?
141 #proxy enabled = yes | no
142 #proxy destination = IP:PORT IP:PORT ...
143 #proxy api key = API_KEY