Make some tweaks/improvements to conf docs (#10528)
Joel Hans committed
Jan 21, 2021 at 14:01 UTC
f8e05ca21197f878feddc867e77af4f7ebe26a12
2 files changed
+26
-15
docs/configure/common-changes.md
+15
-5
@@ -68,11 +68,11 @@ each alarm and notification method is completely customizable.
68
69
To create a new alarm configuration file, initiate an empty file, with a filename that ends in `.conf`, in the
70
`health.d/` directory. The Netdata Agent loads any valid alarm configuration file ending in `.conf` in that directory.
71
-Next, edit the new file with `edit-config`. For example, with a file called `ram-usage.conf`.
71
+Next, edit the new file with `edit-config`. For example, with a file called `example-alarm.conf`.
72
73
```bash
74
-sudo touch health.d/ram-usage.conf
75
-sudo ./edit-config health.d/ram-usage.conf
74
+sudo touch health.d/example-alarm.conf
75
+sudo ./edit-config health.d/example-alarm.conf
76
```
77
78
Or, append your new alarm to an existing file by editing a relevant existing file in the `health.d/` directory.
@@ -87,13 +87,23 @@ the Agent responds to anomalies related to CPU utilization.
87
88
To see which configuration file you need to edit to configure a specific alarm, [view your active
89
alarms](/docs/monitor/view-active-alarms.md) in Netdata Cloud or the local Agent dashboard and look for the **source**
90
-line. For example, it might read `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. Because the source path contains
91
-`health.d/cpu.conf`, you now you that you should run `sudo edit-config health.d/cpu.conf` to configure that alarm.
90
+line. For example, it might read `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`.
91
+
92
+Because the source path contains `health.d/cpu.conf`, run `sudo edit-config health.d/cpu.conf` to configure that alarm.
93
94
### Disable a specific alarm
95
96
Open the configuration file for that alarm and set the `to` line to `silent`.
97
98
+```conf
99
+template: disk_fill_rate
100
+ on: disk.space
101
+ lookup: max -1s at -30m unaligned of avail
102
+ calc: ($this - $avail) / (30 * 60)
103
+ every: 15s
104
+ to: silent
105
+```
106
+
107
### Turn of all alarms and notifications
108
109
Set `enabled` to `no` in the [`[health]` section](/daemon/config/README.md#health-section-options) section of
docs/guides/configure/performance.md
+11
-10
@@ -66,7 +66,7 @@ seconds, respectively.
66
67
```conf
68
[global]
69
- update every: 5
69
+ update every = 5
70
```
71
72
### Specific plugin or collector
@@ -128,6 +128,7 @@ sudo ./edit-config charts.d.conf
128
For example, to disable a few Python collectors:
129
130
```conf
131
+modules:
132
apache: no
133
dockerd: no
134
fail2ban: no
@@ -149,9 +150,9 @@ All the settings are found in the `[global]` section of `netdata.conf`:
150
151
```conf
152
[global]
152
- memory mode = dbengine
153
- page cache size = 32
154
- dbengine multihost disk space = 256
153
+ memory mode = dbengine
154
+ page cache size = 32
155
+ dbengine multihost disk space = 256
156
```
157
158
## Run Netdata behind Nginx
@@ -194,15 +195,15 @@ To disable gzip compression, open `netdata.conf` and find the `[web]` section:
195
196
```conf
197
[web]
197
- enable gzip compression = no
198
+ enable gzip compression = no
199
```
200
201
Or to lower the default compression level:
202
203
```conf
204
[web]
204
- enable gzip compression = yes
205
- gzip compression level = 1
205
+ enable gzip compression = yes
206
+ gzip compression level = 1
207
```
208
209
## Disable logs
@@ -212,9 +213,9 @@ If you installation is working correctly, and you're not actively auditing Netda
213
214
```conf
215
[global]
215
- debug log = none
216
- error log = none
217
- access log = none
216
+ debug log = none
217
+ error log = none
218
+ access log = none
219
```
220
221
## What's next?