summaryrefslogtreecommitdiffstats
path: root/collectors
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2021-01-12 08:12:09 -0700
committerGitHub <noreply@github.com>2021-01-12 08:12:09 -0700
commitdc8dc2476ce064ab04095eadef86416b45909643 (patch)
treeacd09a3cb5d05838fb7ca428eab86917ec87078b /collectors
parentc817387917ec28eabcc45a39c9526858577efc3c (diff)
Add instructions on enabling explicitly disabled collectors (#10418)
* Add enable instructions and fix comment * service -> systemctl * Reverse systemctl order
Diffstat (limited to 'collectors')
-rw-r--r--collectors/python.d.plugin/chrony/README.md19
-rw-r--r--collectors/python.d.plugin/dns_query_time/README.md2
-rw-r--r--collectors/python.d.plugin/dnsdist/README.md2
-rw-r--r--collectors/python.d.plugin/dockerd/README.md2
-rw-r--r--collectors/python.d.plugin/dovecot/README.md2
-rw-r--r--collectors/python.d.plugin/elasticsearch/README.md2
-rw-r--r--collectors/python.d.plugin/energid/README.md2
-rw-r--r--collectors/python.d.plugin/go_expvar/README.md13
-rw-r--r--collectors/python.d.plugin/hpssa/README.md16
-rw-r--r--collectors/python.d.plugin/logind/README.md13
10 files changed, 60 insertions, 13 deletions
diff --git a/collectors/python.d.plugin/chrony/README.md b/collectors/python.d.plugin/chrony/README.md
index ee140b4601..b1e7ec35c0 100644
--- a/collectors/python.d.plugin/chrony/README.md
+++ b/collectors/python.d.plugin/chrony/README.md
@@ -18,15 +18,29 @@ Monitors the precision and statistics of a local chronyd server, and produces:
- system time
## Requirements
+
Verify that user Netdata can execute `chronyc tracking`. If necessary, update `/etc/chrony.conf`, `cmdallow`.
+## Enable the collector
+
+The `chrony` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d.conf
+```
+
+Change the value of the `chrony` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
+restart netdata`, or the appropriate method for your system, to finish enabling the `chrony` collector.
+
## Configuration
Edit the `python.d/chrony.conf` configuration file using `edit-config` from the Netdata [config
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/chrony.conf
```
@@ -41,6 +55,7 @@ local:
command: 'chronyc -n tracking'
```
----
+Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the appropriate method for your
+system, to finish configuring the `chrony` collector.
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fchrony%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/collectors/python.d.plugin/dns_query_time/README.md b/collectors/python.d.plugin/dns_query_time/README.md
index 10a38a0c68..e1fde74716 100644
--- a/collectors/python.d.plugin/dns_query_time/README.md
+++ b/collectors/python.d.plugin/dns_query_time/README.md
@@ -20,7 +20,7 @@ Edit the `python.d/dns_query_time.conf` configuration file using `edit-config` f
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/dns_query_time.conf
```
diff --git a/collectors/python.d.plugin/dnsdist/README.md b/collectors/python.d.plugin/dnsdist/README.md
index 0fcce98edb..7c279efafa 100644
--- a/collectors/python.d.plugin/dnsdist/README.md
+++ b/collectors/python.d.plugin/dnsdist/README.md
@@ -55,7 +55,7 @@ Edit the `python.d/dnsdist.conf` configuration file using `edit-config` from the
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/dnsdist.conf
```
diff --git a/collectors/python.d.plugin/dockerd/README.md b/collectors/python.d.plugin/dockerd/README.md
index bfa0c88908..178bae2cc7 100644
--- a/collectors/python.d.plugin/dockerd/README.md
+++ b/collectors/python.d.plugin/dockerd/README.md
@@ -32,7 +32,7 @@ Edit the `python.d/dockerd.conf` configuration file using `edit-config` from the
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/dockerd.conf
```
diff --git a/collectors/python.d.plugin/dovecot/README.md b/collectors/python.d.plugin/dovecot/README.md
index ed7e977ba7..55aeed3eb5 100644
--- a/collectors/python.d.plugin/dovecot/README.md
+++ b/collectors/python.d.plugin/dovecot/README.md
@@ -81,7 +81,7 @@ Edit the `python.d/dovecot.conf` configuration file using `edit-config` from the
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/dovecot.conf
```
diff --git a/collectors/python.d.plugin/elasticsearch/README.md b/collectors/python.d.plugin/elasticsearch/README.md
index cc816f6f06..d8d7581bc8 100644
--- a/collectors/python.d.plugin/elasticsearch/README.md
+++ b/collectors/python.d.plugin/elasticsearch/README.md
@@ -70,7 +70,7 @@ Edit the `python.d/elasticsearch.conf` configuration file using `edit-config` fr
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/elasticsearch.conf
```
diff --git a/collectors/python.d.plugin/energid/README.md b/collectors/python.d.plugin/energid/README.md
index 85526ec33c..60c829fed9 100644
--- a/collectors/python.d.plugin/energid/README.md
+++ b/collectors/python.d.plugin/energid/README.md
@@ -52,7 +52,7 @@ Edit the `python.d/energid.conf` configuration file using `edit-config` from the
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
-cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/energid.conf
```
diff --git a/collectors/python.d.plugin/go_expvar/README.md b/collectors/python.d.plugin/go_expvar/README.md
index 4db68b04e8..66ebc0b67b 100644
--- a/collectors/python.d.plugin/go_expvar/README.md
+++ b/collectors/python.d.plugin/go_expvar/README.md
@@ -252,6 +252,19 @@ In the above case, the exported variables will be available under `runtime.gorou
`counters.cnt1` and `counters.cnt2` expvar_keys. If the flattening results in a key collision,
the first defined key wins and all subsequent keys with the same name are ignored.
+## Enable the collector
+
+The `go_expvar` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d.conf
+```
+
+Change the value of the `go_expvar` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
+restart netdata`, or the appropriate method for your system, to finish enabling the `go_expvar` collector.
+
## Configuration
Edit the `python.d/go_expvar.conf` configuration file using `edit-config` from the Netdata [config
diff --git a/collectors/python.d.plugin/hpssa/README.md b/collectors/python.d.plugin/hpssa/README.md
index 426f19c536..2079ff2ad7 100644
--- a/collectors/python.d.plugin/hpssa/README.md
+++ b/collectors/python.d.plugin/hpssa/README.md
@@ -29,15 +29,21 @@ This module produces:
3. Logical drive state
4. Physical drive state and temperature
+## Enable the collector
-## Configuration
-
-**hpssa** is disabled by default. Should be explicitly enabled in `python.d.conf`.
+The `hpssa` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
-```yaml
-hpssa: yes
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d.conf
```
+Change the value of the `hpssa` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
+restart netdata`, or the appropriate method for your system, to finish enabling the `hpssa` collector.
+
+## Configuration
+
Edit the `python.d/hpssa.conf` configuration file using `edit-config` from the Netdata [config
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
diff --git a/collectors/python.d.plugin/logind/README.md b/collectors/python.d.plugin/logind/README.md
index 36038dbcc2..3e2d4c1907 100644
--- a/collectors/python.d.plugin/logind/README.md
+++ b/collectors/python.d.plugin/logind/README.md
@@ -26,6 +26,19 @@ It provides the following charts:
- Seats
+## Enable the collector
+
+The `logind` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d.conf
+```
+
+Change the value of the `logind` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
+restart netdata`, or the appropriate method for your system, to finish enabling the `logind` collector.
+
## Configuration
This module needs no configuration. Just make sure the `netdata` user