Added collector config to relevant READMEs (#8052)
Joel Hans committed
Feb 12, 2020 at 05:11 UTC
8166f8bc2aed417285cf08c2a9b60d2ebc3b872c
71 files changed
+619
-70
collectors/charts.d.plugin/ap/README.md
+9
-2
@@ -76,8 +76,15 @@ Station 40:b8:37:5a:ed:5e (on wlan0)
76
77
## Configuration
78
79
-You can only set `ap_update_every=NUMBER` to `/etc/netdata/charts.d/ap.conf`, to give the data collection frequency.
80
-To edit this file on your system run `/etc/netdata/edit-config charts.d/ap.conf`.
79
+Edit the `charts.d/ap.conf` configuration file using `edit-config` from the your agent's [config
80
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
81
+
82
+```bash
83
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
84
+sudo ./edit-config charts.d/ap.conf
85
+```
86
+
87
+You can only set `ap_update_every=NUMBER` to change the data collection frequency.
88
89
## Auto-detection
90
collectors/charts.d.plugin/apcupsd/README.md
+8
-2
@@ -1,7 +1,13 @@
1
# apcupsd
2
3
-_Under construction_
3
+## Configuration
4
5
-Collects UPS metrics
5
+Edit the `charts.d/apcupsd.conf` configuration file using `edit-config` from the your agent's [config
6
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
7
+
8
+```bash
9
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
10
+sudo ./edit-config charts.d/apcupsd.conf
11
+```
12
13
[](<>)
collectors/charts.d.plugin/libreswan/README.md
+8
-2
@@ -13,9 +13,15 @@ The following charts are created, **per tunnel**:
13
- bytes in
14
- bytes out
15
16
-## configuration
16
+## Configuration
17
18
-Its config file is `/etc/netdata/charts.d/libreswan.conf`.
18
+Edit the `charts.d/libreswan.conf` configuration file using `edit-config` from the your agent's [config
19
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
20
+
21
+```bash
22
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
23
+sudo ./edit-config charts.d/libreswan.conf
24
+```
25
26
The plugin executes 2 commands to collect all the information it needs:
27
collectors/charts.d.plugin/nut/README.md
+10
-2
@@ -42,9 +42,17 @@ The following charts will be created:
42
43
- current temperature
44
45
-## configuration
45
+## Configuration
46
47
-This is the internal default for `/etc/netdata/nut.conf`
47
+Edit the `charts.d/nut.conf` configuration file using `edit-config` from the your agent's [config
48
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
49
+
50
+```bash
51
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
52
+sudo ./edit-config charts.d/nut.conf
53
+```
54
+
55
+This is the internal default for `charts.d/nut.conf`
56
57
```sh
58
# a space separated list of UPS names
collectors/charts.d.plugin/opensips/README.md
+8
-2
@@ -1,7 +1,13 @@
1
# OpenSIPS
2
3
-_Under construction_
3
+## Configuration
4
5
-Collects OpenSIPS metrics
5
+Edit the `charts.d/opensips.conf` configuration file using `edit-config` from the your agent's [config
6
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
7
+
8
+```bash
9
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
10
+sudo ./edit-config charts.d/opensips.conf
11
+```
12
13
[](<>)
collectors/charts.d.plugin/sensors/README.md
+10
-2
@@ -24,9 +24,17 @@ The plugin will create Netdata charts for:
24
25
One chart for every sensor chip found and each of the above will be created.
26
27
-## configuration
27
+## Configuration
28
29
-This is the internal default for `/etc/netdata/sensors.conf`
29
+Edit the `charts.d/sensors.conf` configuration file using `edit-config` from the your agent's [config
30
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
31
+
32
+```bash
33
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
34
+sudo ./edit-config charts.d/sensors.conf
35
+```
36
+
37
+This is the internal default for `charts.d/sensors.conf`
38
39
```sh
40
# the directory the kernel keeps sensor data
collectors/python.d.plugin/adaptec_raid/README.md
+10
-2
@@ -35,14 +35,22 @@ Add to `sudoers`:
35
netdata ALL=(root) NOPASSWD: /path/to/arcconf
36
```
37
38
-## configuration
38
+## Configuration
39
40
- **adaptec_raid** is disabled by default. Should be explicitly enabled in `python.d.conf`.
40
+**adaptec_raid** is disabled by default. Should be explicitly enabled in `python.d.conf`.
41
42
```yaml
43
adaptec_raid: yes
44
```
45
46
+Edit the `python.d/adaptec_raid.conf` configuration file using `edit-config` from the your agent's [config
47
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
48
+
49
+```bash
50
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
51
+sudo ./edit-config python.d/adaptec_raid.conf
52
+```
53
+
54
### Screenshot:
55
56
collectors/python.d.plugin/am2320/README.md
+8
@@ -13,6 +13,14 @@ It produces the following charts:
13
14
## configuration
15
16
+Edit the `python.d/am2320.conf` configuration file using `edit-config` from the your agent's [config
17
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
18
+
19
+```bash
20
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
21
+sudo ./edit-config python.d/am2320.conf
22
+```
23
+
24
Raspbery Pi Instructions:
25
26
Hardware install:
collectors/python.d.plugin/apache/README.md
+8
@@ -45,6 +45,14 @@ It produces the following charts:
45
46
## configuration
47
48
+Edit the `python.d/apache.conf` configuration file using `edit-config` from the your agent's [config
49
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
50
+
51
+```bash
52
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
53
+sudo ./edit-config python.d/apache.conf
54
+```
55
+
56
Needs only `url` to server's `server-status?auto`
57
58
Here is an example for 2 servers:
collectors/python.d.plugin/beanstalk/README.md
+8
@@ -105,6 +105,14 @@ Module provides server and tube-level statistics:
105
106
## configuration
107
108
+Edit the `python.d/beanstalk.conf` configuration file using `edit-config` from the your agent's [config
109
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
110
+
111
+```bash
112
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
113
+sudo ./edit-config python.d/beanstalk.conf
114
+```
115
+
116
Sample:
117
118
```yaml
collectors/python.d.plugin/bind_rndc/README.md
+8
@@ -51,6 +51,14 @@ It produces:
51
52
## configuration
53
54
+Edit the `python.d/bind_rndc.conf` configuration file using `edit-config` from the your agent's [config
55
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
56
+
57
+```bash
58
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
59
+sudo ./edit-config python.d/bind_rndc.conf
60
+```
61
+
62
Sample:
63
64
```yaml
collectors/python.d.plugin/boinc/README.md
+8
@@ -9,6 +9,14 @@ as well as ones tracking each of the possible states for tasks.
9
10
## configuration
11
12
+Edit the `python.d/boinc.conf` configuration file using `edit-config` from the your agent's [config
13
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
14
+
15
+```bash
16
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
17
+sudo ./edit-config python.d/boinc.conf
18
+```
19
+
20
BOINC requires use of a password to access it's RPC interface. You can
21
find this password in the `gui_rpc_auth.cfg` file in your BOINC directory.
22
collectors/python.d.plugin/ceph/README.md
+8
@@ -23,6 +23,14 @@ It produces:
23
24
## Configuration
25
26
+Edit the `python.d/ceph.conf` configuration file using `edit-config` from the your agent's [config
27
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
28
+
29
+```bash
30
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
31
+sudo ./edit-config python.d/ceph.conf
32
+```
33
+
34
Sample:
35
36
```yaml
collectors/python.d.plugin/chrony/README.md
+8
@@ -18,6 +18,14 @@ Verify that user Netdata can execute `chronyc tracking`. If necessary, update `/
18
19
## Configuration
20
21
+Edit the `python.d/chrony.conf` configuration file using `edit-config` from the your agent's [config
22
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
23
+
24
+```bash
25
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
26
+sudo ./edit-config python.d/chrony.conf
27
+```
28
+
29
Sample:
30
31
```yaml
collectors/python.d.plugin/couchdb/README.md
+8
@@ -13,6 +13,14 @@ This module monitors vital statistics of a local Apache CouchDB 2.x server, incl
13
14
## Configuration
15
16
+Edit the `python.d/couchdb.conf` configuration file using `edit-config` from the your agent's [config
17
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
18
+
19
+```bash
20
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
21
+sudo ./edit-config python.d/couchdb.conf
22
+```
23
+
24
Sample for a local server running on port 5984:
25
26
```yaml
collectors/python.d.plugin/dns_query_time/README.md
+10
@@ -8,6 +8,16 @@ This module provides DNS query time statistics.
8
9
It produces one aggregate chart or one chart per DNS server, showing the query time.
10
11
+## Configuration
12
+
13
+Edit the `python.d/dns_query_time.conf` configuration file using `edit-config` from the your agent's [config
14
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
15
+
16
+```bash
17
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
18
+sudo ./edit-config python.d/dns_query_time.conf
19
+```
20
+
21
---
22
23
[](<>)
collectors/python.d.plugin/dnsdist/README.md
+8
@@ -47,6 +47,14 @@ The module draws the following charts:
47
48
## Configuration
49
50
+Edit the `python.d/dnsdist.conf` configuration file using `edit-config` from the your agent's [config
51
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
52
+
53
+```bash
54
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
55
+sudo ./edit-config python.d/dnsdist.conf
56
+```
57
+
58
```yaml
59
localhost:
60
name : 'local'
collectors/python.d.plugin/dockerd/README.md
+8
@@ -22,6 +22,14 @@ Following charts are drawn:
22
23
## configuration
24
25
+Edit the `python.d/dockerd.conf` configuration file using `edit-config` from the your agent's [config
26
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
27
+
28
+```bash
29
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
30
+sudo ./edit-config python.d/dockerd.conf
31
+```
32
+
33
```yaml
34
update_every : 1
35
priority : 60000
collectors/python.d.plugin/dovecot/README.md
+8
@@ -71,6 +71,14 @@ Module gives information with following charts:
71
72
## configuration
73
74
+Edit the `python.d/dovecot.conf` configuration file using `edit-config` from the your agent's [config
75
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
76
+
77
+```bash
78
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
79
+sudo ./edit-config python.d/dovecot.conf
80
+```
81
+
82
Sample:
83
84
```yaml
collectors/python.d.plugin/elasticsearch/README.md
+8
@@ -60,6 +60,14 @@ It produces:
60
61
## configuration
62
63
+Edit the `python.d/elasticsearch.conf` configuration file using `edit-config` from the your agent's [config
64
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
65
+
66
+```bash
67
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
68
+sudo ./edit-config python.d/elasticsearch.conf
69
+```
70
+
71
Sample:
72
73
```yaml
collectors/python.d.plugin/energid/README.md
+8
@@ -42,6 +42,14 @@ long daemon startup.
42
43
## Configuration
44
45
+Edit the `python.d/energid.conf` configuration file using `edit-config` from the your agent's [config
46
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
47
+
48
+```bash
49
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
50
+sudo ./edit-config python.d/energid.conf
51
+```
52
+
53
Sample:
54
55
```yaml
collectors/python.d.plugin/fail2ban/README.md
+8
@@ -10,6 +10,14 @@ It produces one chart with multiple lines (one line per jail)
10
11
## configuration
12
13
+Edit the `python.d/fail2ban.conf` configuration file using `edit-config` from the your agent's [config
14
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
15
+
16
+```bash
17
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
18
+sudo ./edit-config python.d/fail2ban.conf
19
+```
20
+
21
Sample:
22
23
```yaml
collectors/python.d.plugin/freeradius/README.md
+8
@@ -46,6 +46,14 @@ It produces:
46
47
## configuration
48
49
+Edit the `python.d/freeradius.conf` configuration file using `edit-config` from the your agent's [config
50
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
51
+
52
+```bash
53
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
54
+sudo ./edit-config python.d/freeradius.conf
55
+```
56
+
57
Sample:
58
59
```yaml
collectors/python.d.plugin/gearman/README.md
+9
-1
@@ -20,7 +20,15 @@ It produces:
20
* Workers idle
21
* Workers running
22
23
-### configuration
23
+## Configuration
24
+
25
+Edit the `python.d/gearman.conf` configuration file using `edit-config` from the your agent's [config
26
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
27
+
28
+```bash
29
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
30
+sudo ./edit-config python.d/gearman.conf
31
+```
32
33
```yaml
34
localhost:
collectors/python.d.plugin/go_expvar/README.md
+9
-1
@@ -251,7 +251,15 @@ In the above case, the exported variables will be available under `runtime.gorou
251
`counters.cnt1` and `counters.cnt2` expvar_keys. If the flattening results in a key collision,
252
the first defined key wins and all subsequent keys with the same name are ignored.
253
254
-**Configuration example**
254
+## Configuration
255
+
256
+Edit the `python.d/go_expvar.conf` configuration file using `edit-config` from the your agent's [config
257
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
258
+
259
+```bash
260
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
261
+sudo ./edit-config python.d/go_expvar.conf
262
+```
263
264
The configuration below matches the second Go application described above.
265
Netdata will monitor and chart memory stats for the application, as well as a custom chart of
collectors/python.d.plugin/haproxy/README.md
+9
-1
@@ -28,7 +28,15 @@ It produces:
28
29
- number of failed servers for every backend (in DOWN state)
30
31
-## configuration
31
+## Configuration
32
+
33
+Edit the `python.d/hapxory.conf` configuration file using `edit-config` from the your agent's [config
34
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
35
+
36
+```bash
37
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
38
+sudo ./edit-config python.d/haproxy.conf
39
+```
40
41
Sample:
42
collectors/python.d.plugin/hddtemp/README.md
+9
-1
@@ -7,7 +7,15 @@ Running `hddtemp` in daemonized mode with access on tcp port
7
8
It produces one chart **Temperature** with dynamic number of dimensions (one per disk)
9
10
-## configuration
10
+## Configuration
11
+
12
+Edit the `python.d/hddtemp.conf` configuration file using `edit-config` from the your agent's [config
13
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
14
+
15
+```bash
16
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
17
+sudo ./edit-config python.d/hddtemp.conf
18
+```
19
20
Sample:
21
collectors/python.d.plugin/hpssa/README.md
+8
@@ -37,6 +37,14 @@ netdata ALL=(root) NOPASSWD: /path/to/ssacli
37
hpssa: yes
38
```
39
40
+Edit the `python.d/hpssa.conf` configuration file using `edit-config` from the your agent's [config
41
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
42
+
43
+```bash
44
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
45
+sudo ./edit-config python.d/hpssa.conf
46
+```
47
+
48
If `ssacli` cannot be found in the `PATH`, configure it in `hpssa.conf`.
49
50
```yaml
collectors/python.d.plugin/httpcheck/README.md
+9
-1
@@ -17,7 +17,15 @@ Following charts are drawn per job:
17
- Connection failed: port not listening or blocked
18
- Connection timed out: host or port unreachable
19
20
-## configuration
20
+## Configuration
21
+
22
+Edit the `python.d/httpcheck.conf` configuration file using `edit-config` from the your agent's [config
23
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
24
+
25
+```bash
26
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
27
+sudo ./edit-config python.d/httpcheck.conf
28
+```
29
30
Sample configuration and their default values.
31
collectors/python.d.plugin/icecast/README.md
+9
-1
@@ -12,7 +12,15 @@ It produces the following charts:
12
13
- source number
14
15
-## configuration
15
+## Configuration
16
+
17
+Edit the `python.d/icecast.conf` configuration file using `edit-config` from the your agent's [config
18
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
19
+
20
+```bash
21
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
22
+sudo ./edit-config python.d/icecast.conf
23
+```
24
25
Needs only `url` to server's `/status-json.xsl`
26
collectors/python.d.plugin/ipfs/README.md
+9
-1
@@ -11,7 +11,15 @@ Module monitors [IPFS](https://ipfs.io) basic information.
11
12
- peers
13
14
-## configuration
14
+## Configuration
15
+
16
+Edit the `python.d/ipfs.conf` configuration file using `edit-config` from the your agent's [config
17
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
18
+
19
+```bash
20
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
21
+sudo ./edit-config python.d/ipfs.conf
22
+```
23
24
Only url to IPFS server is needed.
25
collectors/python.d.plugin/isc_dhcpd/README.md
+9
-1
@@ -21,7 +21,15 @@ It produces:
21
22
- leases (number of active leases in pool)
23
24
-## configuration
24
+## Configuration
25
+
26
+Edit the `python.d/isc_dhcpd.conf` configuration file using `edit-config` from the your agent's [config
27
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
28
+
29
+```bash
30
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
31
+sudo ./edit-config python.d/isc_dhcpd.conf
32
+```
33
34
Sample:
35
collectors/python.d.plugin/litespeed/README.md
+9
-1
@@ -44,7 +44,15 @@ It produces:
44
45
- hits
46
47
-## configuration
47
+## Configuration
48
+
49
+Edit the `python.d/litespeed.conf` configuration file using `edit-config` from the your agent's [config
50
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
51
+
52
+```bash
53
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
54
+sudo ./edit-config python.d/litespeed.conf
55
+```
56
57
```yaml
58
local:
collectors/python.d.plugin/logind/README.md
+9
-1
@@ -22,7 +22,7 @@ It provides the following charts:
22
23
## configuration
24
25
-This module needs no configuration. Just make sure the `netdata` user
25
+This module needs no configuration. Just make sure the `netdata` user
26
can run the `loginctl` command and get a session list without having to
27
specify a path.
28
@@ -35,6 +35,14 @@ specify it using the `command` key like so:
35
command: '/path/to/other/command'
36
```
37
38
+Edit the `python.d/logind.conf` configuration file using `edit-config` from the your agent's [config
39
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
40
+
41
+```bash
42
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
43
+sudo ./edit-config python.d/logind.conf
44
+```
45
+
46
## notes
47
48
- This module's ability to track logins is dependent on what PAM services
collectors/python.d.plugin/megacli/README.md
+10
-2
@@ -37,7 +37,7 @@ Add to `sudoers`:
37
netdata ALL=(root) NOPASSWD: /path/to/megacli
38
```
39
40
-### configuration
40
+### Configuration
41
42
**megacli** is disabled by default. Should be explicitly enabled in `python.d.conf`.
43
@@ -45,7 +45,15 @@ netdata ALL=(root) NOPASSWD: /path/to/megacli
45
megacli: yes
46
```
47
48
-Battery stats disabled by default. To enable them modify `megacli.conf`.
48
+Edit the `python.d/megacli.conf` configuration file using `edit-config` from the your agent's [config
49
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
50
+
51
+```bash
52
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
53
+sudo ./edit-config python.d/megacli.conf
54
+```
55
+
56
+Battery stats disabled by default. To enable them, modify `megacli.conf`.
57
58
```yaml
59
do_battery: yes
collectors/python.d.plugin/memcached/README.md
+9
-1
@@ -66,7 +66,15 @@ Memcached monitoring module. Data grabbed from [stats interface](https://github.
66
67
- rate
68
69
-## configuration
69
+## Configuration
70
+
71
+Edit the `python.d/memcached.conf` configuration file using `edit-config` from the your agent's [config
72
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
73
+
74
+```bash
75
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
76
+sudo ./edit-config python.d/memcached.conf
77
+```
78
79
Sample:
80
collectors/python.d.plugin/mongodb/README.md
+9
-1
@@ -175,7 +175,15 @@ db.createUser({
175
})
176
```
177
178
-### configuration
178
+## Configuration
179
+
180
+Edit the `python.d/mongodb.conf` configuration file using `edit-config` from the your agent's [config
181
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
182
+
183
+```bash
184
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
185
+sudo ./edit-config python.d/mongodb.conf
186
+```
187
188
Sample:
189
collectors/python.d.plugin/monit/README.md
+9
-1
@@ -19,7 +19,15 @@ Monit monitoring module. Data is grabbed from stats XML interface (exists for a
19
- Hosts (+latency)
20
- Network interfaces
21
22
-## configuration
22
+## Configuration
23
+
24
+Edit the `python.d/monit.conf` configuration file using `edit-config` from the your agent's [config
25
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
26
+
27
+```bash
28
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
29
+sudo ./edit-config python.d/monit.conf
30
+```
31
32
Sample:
33
collectors/python.d.plugin/mysql/README.md
+9
-1
@@ -328,7 +328,15 @@ This module will produce following charts (if data is available):
328
- update
329
- other
330
331
-## configuration
331
+## Configuration
332
+
333
+Edit the `python.d/mysql.conf` configuration file using `edit-config` from the your agent's [config
334
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
335
+
336
+```bash
337
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
338
+sudo ./edit-config python.d/mysql.conf
339
+```
340
341
You can provide, per server, the following:
342
collectors/python.d.plugin/nginx/README.md
+10
-2
@@ -30,9 +30,17 @@ It produces following charts:
30
- accepts
31
- handled
32
33
-## configuration
33
+## Configuration
34
35
-Needs only `url` to server's `stub_status`
35
+Edit the `python.d/nginx.conf` configuration file using `edit-config` from the your agent's [config
36
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
37
+
38
+```bash
39
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
40
+sudo ./edit-config python.d/nginx.conf
41
+```
42
+
43
+Needs only `url` to server's `stub_status`.
44
45
Here is an example for local server:
46
collectors/python.d.plugin/nginx_plus/README.md
+11
-3
@@ -134,11 +134,19 @@ For every cache:
134
135
- usage
136
137
-## configuration
137
+## Configuration
138
139
-Needs only `url` to server's `status`
139
+Edit the `python.d/nginx_plus.conf` configuration file using `edit-config` from the your agent's [config
140
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
141
141
-Here is an example for local server:
142
+```bash
143
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
144
+sudo ./edit-config python.d/nginx_plus.conf
145
+```
146
+
147
+Needs only `url` to server's `status`.
148
+
149
+Here is an example for a local server:
150
151
```yaml
152
local:
collectors/python.d.plugin/ntpd/README.md
+9
-1
@@ -41,7 +41,15 @@ It produces:
41
- ppoll
42
- precision
43
44
-## configuration
44
+## Configuration
45
+
46
+Edit the `python.d/ntpd.conf` configuration file using `edit-config` from the your agent's [config
47
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
48
+
49
+```bash
50
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
51
+sudo ./edit-config python.d/ntpd.conf
52
+```
53
54
Sample:
55
collectors/python.d.plugin/nvidia_smi/README.md
+9
-1
@@ -33,7 +33,15 @@ It produces:
33
- clock speed
34
- PCI bandwidth
35
36
-## configuration
36
+## Configuration
37
+
38
+Edit the `python.d/nvidia_smi.conf` configuration file using `edit-config` from the your agent's [config
39
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
40
+
41
+```bash
42
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
43
+sudo ./edit-config python.d/nvidia_smi.conf
44
+```
45
46
Sample:
47
collectors/python.d.plugin/openldap/README.md
+9
-1
@@ -47,7 +47,15 @@ Statistics are taken from LDAP monitoring interface. Manual page, slapd-monitor(
47
- read
48
- write
49
50
-### configuration
50
+## Configuration
51
+
52
+Edit the `python.d/openldap.conf` configuration file using `edit-config` from the your agent's [config
53
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
54
+
55
+```bash
56
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
57
+sudo ./edit-config python.d/openldap.conf
58
+```
59
60
Sample:
61
collectors/python.d.plugin/oracledb/README.md
+9
-1
@@ -57,7 +57,15 @@ GRANT CONNECT TO netdata;
57
GRANT SELECT_CATALOG_ROLE TO netdata;
58
```
59
60
-### configuration
60
+## Configuration
61
+
62
+Edit the `python.d/oracledb.conf` configuration file using `edit-config` from the your agent's [config
63
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
64
+
65
+```bash
66
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
67
+sudo ./edit-config python.d/oracledb.conf
68
+```
69
70
```yaml
71
local:
collectors/python.d.plugin/ovpn_status_log/README.md
+9
-1
@@ -22,7 +22,15 @@ It produces:
22
- in
23
- out
24
25
-## configuration
25
+## Configuration
26
+
27
+Edit the `python.d/ovpn_status_log.conf` configuration file using `edit-config` from the your agent's [config
28
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
29
+
30
+```bash
31
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
32
+sudo ./edit-config python.d/ovpn_status_log.conf
33
+```
34
35
Sample:
36
collectors/python.d.plugin/phpfpm/README.md
+8
@@ -20,6 +20,14 @@ It produces following charts:
20
21
## Configuration
22
23
+Edit the `python.d/phpfpm.conf` configuration file using `edit-config` from the your agent's [config
24
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
25
+
26
+```bash
27
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
28
+sudo ./edit-config python.d/phpfpm.conf
29
+```
30
+
31
Needs only `url` to server's `status`. Here is an example for local and remote instances:
32
33
```yaml
collectors/python.d.plugin/portcheck/README.md
+9
-1
@@ -16,7 +16,15 @@ Following charts are drawn per host:
16
- Connection refused: port not listening or blocked
17
- Connection timed out: host or port unreachable
18
19
-## configuration
19
+## Configuration
20
+
21
+Edit the `python.d/portcheck.conf` configuration file using `edit-config` from the your agent's [config
22
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
23
+
24
+```bash
25
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
26
+sudo ./edit-config python.d/portcheck.conf
27
+```
28
29
```yaml
30
server:
collectors/python.d.plugin/postgres/README.md
+11
-3
@@ -57,9 +57,17 @@ Following charts are drawn:
57
58
- locks
59
60
-## configuration
60
+## Configuration
61
62
-For all available options please see module [configuration file](postgres.conf).
62
+Edit the `python.d/postgres.conf` configuration file using `edit-config` from the your agent's [config
63
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
64
+
65
+```bash
66
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
67
+sudo ./edit-config python.d/postgres.conf
68
+```
69
+
70
+When no configuration file is found, the module tries to connect to TCP/IP socket: `localhost:5432`.
71
72
```yaml
73
socket:
@@ -75,7 +83,7 @@ tcp:
83
port : 5432
84
```
85
78
-When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:5432`.
86
+For all available options please see module [configuration file](postgres.conf).
87
88
---
89
collectors/python.d.plugin/powerdns/README.md
+9
-1
@@ -75,7 +75,15 @@ Powerdns charts:
75
- packetcache-entries
76
- negcache-entries
77
78
-## configuration
78
+## Configuration
79
+
80
+Edit the `python.d/powerdns.conf` configuration file using `edit-config` from the your agent's [config
81
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
82
+
83
+```bash
84
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
85
+sudo ./edit-config python.d/powerdns.conf
86
+```
87
88
```yaml
89
local:
collectors/python.d.plugin/proxysql/README.md
+9
-1
@@ -65,7 +65,15 @@ It produces:
65
- Commands
66
- 100us, 500us, ..., 10s, inf: the total number of commands of the given type which executed within the specified time limit and the previous one.
67
68
-## configuration
68
+## Configuration
69
+
70
+Edit the `python.d/proxysql.conf` configuration file using `edit-config` from the your agent's [config
71
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
72
+
73
+```bash
74
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
75
+sudo ./edit-config python.d/proxysql.conf
76
+```
77
78
```yaml
79
tcpipv4:
collectors/python.d.plugin/puppet/README.md
+9
-1
@@ -24,7 +24,15 @@ Following charts are drawn:
24
- max
25
- used
26
27
-## configuration
27
+## Configuration
28
+
29
+Edit the `python.d/puppet.conf` configuration file using `edit-config` from the your agent's [config
30
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
31
+
32
+```bash
33
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
34
+sudo ./edit-config python.d/puppet.conf
35
+```
36
37
```yaml
38
puppetdb:
collectors/python.d.plugin/rabbitmq/README.md
+11
-3
@@ -62,7 +62,17 @@ Per Vhost charts:
62
- redeliver
63
- return_unroutable
64
65
-## configuration
65
+## Configuration
66
+
67
+Edit the `python.d/rabbitmq.conf` configuration file using `edit-config` from the your agent's [config
68
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
69
+
70
+```bash
71
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
72
+sudo ./edit-config python.d/rabbitmq.conf
73
+```
74
+
75
+When no configuration file is found, module tries to connect to: `localhost:15672`.
76
77
```yaml
78
socket:
@@ -73,8 +83,6 @@ socket:
83
pass : 'guest'
84
```
85
76
-When no configuration file is found, module tries to connect to: `localhost:15672`.
77
-
86
---
87
88
[](<>)
collectors/python.d.plugin/redis/README.md
+9
-1
@@ -30,7 +30,15 @@ Following charts are drawn:
30
31
- connected
32
33
-## configuration
33
+## Configuration
34
+
35
+Edit the `python.d/redis.conf` configuration file using `edit-config` from the your agent's [config
36
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
37
+
38
+```bash
39
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
40
+sudo ./edit-config python.d/redis.conf
41
+```
42
43
```yaml
44
socket:
collectors/python.d.plugin/rethinkdbs/README.md
+9
-1
@@ -21,7 +21,15 @@ Following charts are drawn:
21
22
- documents
23
24
-## configuration
24
+## Configuration
25
+
26
+Edit the `python.d/rethinkdbs.conf` configuration file using `edit-config` from the your agent's [config
27
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
28
+
29
+```bash
30
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
31
+sudo ./edit-config python.d/rethinkdbs.conf
32
+```
33
34
```yaml
35
localhost:
collectors/python.d.plugin/retroshare/README.md
+8
@@ -15,6 +15,14 @@ This module produces the following charts:
15
16
## Configuration
17
18
+Edit the `python.d/retroshare.conf` configuration file using `edit-config` from the your agent's [config
19
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
20
+
21
+```bash
22
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
23
+sudo ./edit-config python.d/retroshare.conf
24
+```
25
+
26
Here is an example for 2 servers:
27
28
```yaml
collectors/python.d.plugin/riakkv/README.md
+9
-1
@@ -94,7 +94,15 @@ listed
94
- bad_entry
95
- extract_fail
96
97
-## configuration
97
+## Configuration
98
+
99
+Edit the `python.d/riakkv.conf` configuration file using `edit-config` from the your agent's [config
100
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
101
+
102
+```bash
103
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
104
+sudo ./edit-config python.d/riakkv.conf
105
+```
106
107
The module needs to be passed the full URL to Riak's stats endpoint.
108
For example:
collectors/python.d.plugin/samba/README.md
+10
-2
@@ -67,14 +67,22 @@ Add to `sudoers`:
67
netdata ALL=(root) NOPASSWD: /path/to/smbstatus
68
```
69
70
-## configuration
70
+## Configuration
71
72
- **samba** is disabled by default. Should be explicitly enabled in `python.d.conf`.
72
+**samba** is disabled by default. Should be explicitly enabled in `python.d.conf`.
73
74
```yaml
75
samba: yes
76
```
77
78
+Edit the `python.d/samba.conf` configuration file using `edit-config` from the your agent's [config
79
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
80
+
81
+```bash
82
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
83
+sudo ./edit-config python.d/samba.conf
84
+```
85
+
86
---
87
88
[](<>)
collectors/python.d.plugin/sensors/README.md
+7
-1
@@ -6,7 +6,13 @@ Charts are created dynamically.
6
7
## configuration
8
9
-For detailed configuration information please read [`sensors.conf`](sensors.conf) file.
9
+Edit the `python.d/sensors.conf` configuration file using `edit-config` from the your agent's [config
10
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
11
+
12
+```bash
13
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
14
+sudo ./edit-config python.d/sensors.conf
15
+```
16
17
### possible issues
18
collectors/python.d.plugin/smartd_log/README.md
+9
-1
@@ -97,7 +97,15 @@ Otherwise, all the smartd `.csv` files may get written to `/var/lib/smartmontool
97
98
`smartd` appends logs at every run. It's strongly recommended to use `logrotate` for smartd files.
99
100
-## configuration
100
+## Configuration
101
+
102
+Edit the `python.d/smartd_log.conf` configuration file using `edit-config` from the your agent's [config
103
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
104
+
105
+```bash
106
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
107
+sudo ./edit-config python.d/smartd_log.conf
108
+```
109
110
```yaml
111
local:
collectors/python.d.plugin/spigotmc/README.md
+9
-1
@@ -9,7 +9,15 @@ active users.
9
This is not compatible with Spigot plugins which change the format of
10
the data returned by the `tps` or `list` console commands.
11
12
-## configuration
12
+## Configuration
13
+
14
+Edit the `python.d/spigotmc.conf` configuration file using `edit-config` from the your agent's [config
15
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
16
+
17
+```bash
18
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
19
+sudo ./edit-config python.d/spigotmc.conf
20
+```
21
22
```yaml
23
host: localhost
collectors/python.d.plugin/springboot/README.md
+7
-1
@@ -94,7 +94,13 @@ Please refer [Spring Boot Actuator: Production-ready Features](https://docs.spri
94
95
## Usage
96
97
-The springboot module is enabled by default. It looks up `http://localhost:8080/metrics` and `http://127.0.0.1:8080/metrics` to detect Spring Boot application by default. You can change it by editing `/etc/netdata/python.d/springboot.conf` (to edit it on your system run `/etc/netdata/edit-config python.d/springboot.conf`).
97
+Edit the `python.d/springboot.conf` configuration file using `edit-config` from the your agent's [config
98
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
99
+
100
+```bash
101
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
102
+sudo ./edit-config python.d/springboot.conf
103
+```
104
105
This module defines some common charts, and you can add custom charts by change the configurations.
106
collectors/python.d.plugin/squid/README.md
+9
-1
@@ -26,7 +26,15 @@ It produces following charts:
26
- requests
27
- errors
28
29
-## configuration
29
+## Configuration
30
+
31
+Edit the `python.d/squid.conf` configuration file using `edit-config` from the your agent's [config
32
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
33
+
34
+```bash
35
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
36
+sudo ./edit-config python.d/squid.conf
37
+```
38
39
```yaml
40
priority : 50000
collectors/python.d.plugin/tomcat/README.md
+9
-1
@@ -21,7 +21,15 @@ Charts:
21
22
- jvm
23
24
-## configuration
24
+## Configuration
25
+
26
+Edit the `python.d/tomcat.conf` configuration file using `edit-config` from the your agent's [config
27
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
28
+
29
+```bash
30
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
31
+sudo ./edit-config python.d/tomcat.conf
32
+```
33
34
```yaml
35
localhost:
collectors/python.d.plugin/tor/README.md
+10
-2
@@ -14,9 +14,17 @@ It produces only one chart:
14
- read
15
- write
16
17
-## configuration
17
+## Configuration
18
19
-Needs only `control_port`
19
+Edit the `python.d/tor.conf` configuration file using `edit-config` from the your agent's [config
20
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
21
+
22
+```bash
23
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
24
+sudo ./edit-config python.d/tor.conf
25
+```
26
+
27
+Needs only `control_port`.
28
29
Here is an example for local server:
30
collectors/python.d.plugin/traefik/README.md
+9
-1
@@ -39,7 +39,15 @@ It produces:
39
40
- Traefik server uptime
41
42
-## configuration
42
+## Configuration
43
+
44
+Edit the `python.d/traefik.conf` configuration file using `edit-config` from the your agent's [config
45
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
46
+
47
+```bash
48
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
49
+sudo ./edit-config python.d/traefik.conf
50
+```
51
52
Needs only `url` to server's `health`
53
collectors/python.d.plugin/uwsgi/README.md
+9
-1
@@ -23,7 +23,15 @@ Following charts are drawn:
23
4. **Harakiris**
24
5. **Respawns**
25
26
-## configuration
26
+## Configuration
27
+
28
+Edit the `python.d/uwsgi.conf` configuration file using `edit-config` from the your agent's [config
29
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
30
+
31
+```bash
32
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
33
+sudo ./edit-config python.d/uwsgi.conf
34
+```
35
36
```yaml
37
socket:
collectors/python.d.plugin/varnish/README.md
+8
@@ -37,6 +37,14 @@ For every disk (SMF):
37
38
## Configuration
39
40
+Edit the `python.d/varnish.conf` configuration file using `edit-config` from the your agent's [config
41
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
42
+
43
+```bash
44
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
45
+sudo ./edit-config python.d/varnish.conf
46
+```
47
+
48
Only one parameter is supported:
49
50
```yaml
collectors/python.d.plugin/w1sensor/README.md
+8
-2
@@ -6,9 +6,15 @@ Currently temperature sensors are supported and automatically detected.
6
7
Charts are created dynamically based on the number of detected sensors.
8
9
-## configuration
9
+## Configuration
10
11
-For detailed configuration information please read [`w1sensor.conf`](w1sensor.conf) file.
11
+Edit the `python.d/w1sensor.conf` configuration file using `edit-config` from the your agent's [config
12
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
13
+
14
+```bash
15
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
16
+sudo ./edit-config python.d/w1sensor.conf
17
+```
18
19
---
20
collectors/python.d.plugin/web_log/README.md
+10
-2
@@ -27,6 +27,14 @@ If Netdata is installed on a system running a web server, it will detect it and
27
28
## Configuration
29
30
+Edit the `python.d/web_log.conf` configuration file using `edit-config` from the your agent's [config
31
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
32
+
33
+```bash
34
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
35
+sudo ./edit-config python.d/web_log.conf
36
+```
37
+
38
[**netdata**](https://my-netdata.io/) has a powerful `web_log` plugin, capable of incrementally parsing any number of web server log files. This plugin is automatically started with [**netdata**](https://my-netdata.io/) and comes, pre-configured, for finding web server log files on popular distributions. Its configuration is at [`/etc/netdata/python.d/web_log.conf`](web_log.conf), like this:
39
40
```yaml
@@ -42,8 +50,8 @@ apache_log:
50
observium : 'observium'
51
```
52
45
-Theodule has preconfigured jobs for nginx, apache and gunicorn on various distros.
46
-You can add one such section, for each of your web server log files.
53
+The module has preconfigured jobs for nginx, apache and gunicorn on various distros.
54
+You can add one such section for each of your web server log files.
55
56
> **Important**<br/>Keep in mind [**netdata**](https://my-netdata.io/) runs as user `netdata`. So, make sure user `netdata` has access to the logs directory and can read the log file.
57
docs/step-by-step/step-04.md
+1
-1
@@ -57,7 +57,7 @@ Let's give it a shot. Navigate to your Netdata config directory. To use `edit-co
57
have permissions to edit the file. On Linux/MacOS systems, you can usually use `sudo` to elevate your permissions.
58
59
```bash
60
-cd /etc/netdata # Replace this path with your Netdata config directory as found in the steps above
60
+cd /etc/netdata # Replace this path with your Netdata config directory, if different as found in the steps above
61
sudo ./edit-config netdata.conf
62
```
63