]> arthur.barton.de Git - netdata.git/blob - conf.d/aggregated_hosts.conf
updated info
[netdata.git] / conf.d / aggregated_hosts.conf
1 # netdata configuration for aggregating data from remote hosts
2 #
3 # API keys authorize a pair of sending-receiving netdata servers.
4 # Once their communication is authorized, they can exchange metrics for any
5 # number of hosts.
6 #
7 # You can generate API keys, with the linux command: uuidgen
8 #
9 # -----------------------------------------------------------------------------
10 # 1. SLAVE NETDATA - THE ONE THAT WILL BE SENDING METRICS
11 #
12 #    In /etc/netdata/netdata.conf you have a configuration like this:
13 #
14 #    [stream]
15 #
16 #        # enable or disable sending metrics.
17 #        # default: no
18 #            enabled = yes
19 #
20 #        # one or more netdata hosts to send metrics to.
21 #        # only one will get them, the first available.
22 #            destination = HOST1:PORT1 HOST2:PORT2 ...
23 #
24 #        # the API key to use, to authorize ourselves
25 #            api key =  API_KEY
26 #
27 # -----------------------------------------------------------------------------
28 # 2. MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
29 #
30 #    Use this file to define the API keys is accepts.
31 #
32 #    You can have one API key per slave, or the same API key for all slaves.
33 #
34 #    All options below are used in this order:
35 #
36 #    a) MACHINE_GUID (settings for each machine)
37 #    b) API_KEY      (settings for the API key)
38 #    c) this netdata defaults (as in netdata.conf)
39 #
40 #    You can combine the above (the more specific setting will be used).
41 #
42 # -----------------------------------------------------------------------------
43
44 # API key authentication
45 # If the key is not listed here, it will not be able to connect.
46
47 [API_KEY]
48     # Default settings for the API key
49
50     # You can disable the API key, by setting this to: no
51     # The default (for unknown API keys) is also: no
52 #    enabled = yes
53
54     # The default history in entries, for all hosts using this API key.
55     # You can also set it per host below.
56     # If you don't set it here, the history size of the central netdata
57     # will be used
58 #    default history = 3600
59
60     # The default memory mode to be used for all hosts using this API key.
61     # You can also set it per host below.
62     # If you don't set it here, the memory mode of the central netdata
63     # will be used.
64     # Valid modes: save (load/save db), map (like swap), ram (no disk)
65 #    default memory mode = save
66
67     # Shall we enable health monitoring for the hosts using this API key?
68     # 3 values:
69     #    yes     enable alarms
70     #    no      do not enable alarms
71     #    auto    enable alarms, only when the host is streaming metrics
72     # You can also set it per host, below.
73     # The default is the same as the central netdata
74 #    health enabled by default = auto
75
76
77 # -----------------------------------------------------------------------------
78 # Each netdata has a unique GUID - generated the first time netdata starts.
79 # You can find it at /var/lib/netdata/registry/netdata.public.unique.id
80 # The host sending data will have one. If it is static and you can find it,
81 # you can give settings for each specific host here.
82
83 [MACHINE_GUID]
84     # This can be used to stop receiving data
85     # THIS IS NOT A SECURITY MECHANISM - AN ATTACKER CAN SET ANY OTHER GUID.
86     # Use only the API key for security.
87 #    enabled = yes
88
89     # The number of entries in the database
90 #    history = 3600
91
92     # The memory mode of the database
93 #    memory mode = save
94
95     # Health / alarms control
96 #    health enabled = yes
97