Add instructions on enabling explicitly disabled collectors (#10418)
* Add enable instructions and fix comment * service -> systemctl * Reverse systemctl order
Joel Hans committed
Jan 12, 2021 at 08:12 UTC
dc8dc2476ce064ab04095eadef86416b45909643
10 files changed
+60
-13
collectors/python.d.plugin/chrony/README.md
+17
-2
@@ -18,15 +18,29 @@ Monitors the precision and statistics of a local chronyd server, and produces:
18
- system time
19
20
## Requirements
21
+
22
Verify that user Netdata can execute `chronyc tracking`. If necessary, update `/etc/chrony.conf`, `cmdallow`.
23
24
+## Enable the collector
25
+
26
+The `chrony` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
27
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
28
+
29
+```bash
30
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
31
+sudo ./edit-config python.d.conf
32
+```
33
+
34
+Change the value of the `chrony` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
35
+restart netdata`, or the appropriate method for your system, to finish enabling the `chrony` collector.
36
+
37
## Configuration
38
39
Edit the `python.d/chrony.conf` configuration file using `edit-config` from the Netdata [config
40
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
41
42
```bash
29
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
43
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
44
sudo ./edit-config python.d/chrony.conf
45
```
46
@@ -41,6 +55,7 @@ local:
55
command: 'chronyc -n tracking'
56
```
57
44
----
58
+Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the appropriate method for your
59
+system, to finish configuring the `chrony` collector.
60
61
[](<>)
collectors/python.d.plugin/dns_query_time/README.md
+1
-1
@@ -20,7 +20,7 @@ Edit the `python.d/dns_query_time.conf` configuration file using `edit-config` f
20
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
21
22
```bash
23
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
23
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
24
sudo ./edit-config python.d/dns_query_time.conf
25
```
26
collectors/python.d.plugin/dnsdist/README.md
+1
-1
@@ -55,7 +55,7 @@ Edit the `python.d/dnsdist.conf` configuration file using `edit-config` from the
55
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
56
57
```bash
58
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
58
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
59
sudo ./edit-config python.d/dnsdist.conf
60
```
61
collectors/python.d.plugin/dockerd/README.md
+1
-1
@@ -32,7 +32,7 @@ Edit the `python.d/dockerd.conf` configuration file using `edit-config` from the
32
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
33
34
```bash
35
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
35
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
36
sudo ./edit-config python.d/dockerd.conf
37
```
38
collectors/python.d.plugin/dovecot/README.md
+1
-1
@@ -81,7 +81,7 @@ Edit the `python.d/dovecot.conf` configuration file using `edit-config` from the
81
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
82
83
```bash
84
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
84
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
85
sudo ./edit-config python.d/dovecot.conf
86
```
87
collectors/python.d.plugin/elasticsearch/README.md
+1
-1
@@ -70,7 +70,7 @@ Edit the `python.d/elasticsearch.conf` configuration file using `edit-config` fr
70
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
71
72
```bash
73
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
73
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
74
sudo ./edit-config python.d/elasticsearch.conf
75
```
76
collectors/python.d.plugin/energid/README.md
+1
-1
@@ -52,7 +52,7 @@ Edit the `python.d/energid.conf` configuration file using `edit-config` from the
52
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
53
54
```bash
55
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
55
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
56
sudo ./edit-config python.d/energid.conf
57
```
58
collectors/python.d.plugin/go_expvar/README.md
+13
@@ -252,6 +252,19 @@ In the above case, the exported variables will be available under `runtime.gorou
252
`counters.cnt1` and `counters.cnt2` expvar_keys. If the flattening results in a key collision,
253
the first defined key wins and all subsequent keys with the same name are ignored.
254
255
+## Enable the collector
256
+
257
+The `go_expvar` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
258
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
259
+
260
+```bash
261
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
262
+sudo ./edit-config python.d.conf
263
+```
264
+
265
+Change the value of the `go_expvar` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
266
+restart netdata`, or the appropriate method for your system, to finish enabling the `go_expvar` collector.
267
+
268
## Configuration
269
270
Edit the `python.d/go_expvar.conf` configuration file using `edit-config` from the Netdata [config
collectors/python.d.plugin/hpssa/README.md
+11
-5
@@ -29,15 +29,21 @@ This module produces:
29
3. Logical drive state
30
4. Physical drive state and temperature
31
32
+## Enable the collector
33
33
-## Configuration
34
-
35
-**hpssa** is disabled by default. Should be explicitly enabled in `python.d.conf`.
34
+The `hpssa` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
35
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
36
37
-```yaml
38
-hpssa: yes
37
+```bash
38
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
39
+sudo ./edit-config python.d.conf
40
```
41
42
+Change the value of the `hpssa` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
43
+restart netdata`, or the appropriate method for your system, to finish enabling the `hpssa` collector.
44
+
45
+## Configuration
46
+
47
Edit the `python.d/hpssa.conf` configuration file using `edit-config` from the Netdata [config
48
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
49
collectors/python.d.plugin/logind/README.md
+13
@@ -26,6 +26,19 @@ It provides the following charts:
26
27
- Seats
28
29
+## Enable the collector
30
+
31
+The `logind` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
32
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
33
+
34
+```bash
35
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
36
+sudo ./edit-config python.d.conf
37
+```
38
+
39
+Change the value of the `logind` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
40
+restart netdata`, or the appropriate method for your system, to finish enabling the `logind` collector.
41
+
42
## Configuration
43
44
This module needs no configuration. Just make sure the `netdata` user