]> arthur.barton.de Git - netdata.git/blob - conf.d/aggregated_hosts.conf
implemented API authentication
[netdata.git] / conf.d / aggregated_hosts.conf
1 # netdata configuration for aggregating data from remote hosts
2 #
3 # 1. You need an API key: API_KEY_GENERATED_BY_UUIDGEN
4 #
5 #    You can generate one with the command: uuidgen
6 #    You can add many API key sections, for different API keys
7 #
8 # 2. All options below are used in this order:
9 #
10 #    a) MACHINE_GUID (settings for each machine)
11 #    b) API_KEY      (settings for the API key)
12 #    c) this netdata defaults (as in netdata.conf)
13 #
14 #    You can combine the above (the more specific will be used).
15 #
16 # 3. At the remote host that will be sending metrics, you need
17 #    to add in netdata.conf, the following:
18 #
19 #    [global]
20 #        central netdata to send all data = 10.11.12.1:19999
21 #        central netdata api key = API_KEY_GENERATED_BY_UUIDGEN
22 #
23 #    Of course, the same API_KEY_GENERATED_BY_UUIDGEN key must
24 #    given there (the remote host) and here (the central netdata).
25 #
26 # -----------------------------------------------------------------------------
27
28 [API_KEY_GENERATED_BY_UUIDGEN]
29     # You can disable the API key, by setting this to: no
30     # The default (for unknown API keys) is also: no
31 #    enabled = yes
32
33     # The default history in entries, for all hosts using this API key.
34     # You can also set it per host below.
35     # If you don't set it here, the history size of the central netdata
36     # will be used
37 #    default history = 3600
38
39     # The default memory mode to be used for all hosts using this API key.
40     # You can also set it per host below.
41     # If you don't set it here, the memory mode of the central netdata
42     # will be used
43 #    default memory mode = save
44
45     # Shall we enable health monitoring for the hosts using this API key?
46     # 3 values:
47     #    yes     enable alarms
48     #    no      do not enable alarms
49     #    auto    enable alarms, only when the host is streaming metrics
50     # You can also set it per host, below.
51     # The default is the same as the central netdata
52 #    health enabled by default = auto
53
54
55 # -----------------------------------------------------------------------------
56 # Each netdata has a unique GUID - generated the first time netdata starts.
57 # You can find it at /var/lib/netdata/registry/netdata.public.unique.id
58 # The host sending data will have one. If it is static and you can find it,
59 # you can give settings for each specific host here.
60
61 [MACHINE_GUID]
62     # This can be used to stop receiving data
63     # THIS IS NOT A SECURITY MECHANISM - AN ATTACKER CAN SET ANY OTHER GUID.
64     # Use only the API key for security.
65 #    enabled = yes
66
67     # The number of entries in the database
68 #    history = 3600
69
70     # The memory mode of the database
71 #    memory mode = save
72
73     # Health / alarms control
74 #    health enabled = yes
75