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