diff options
author | Joel Hans <joel@netdata.cloud> | 2021-01-21 14:01:54 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-21 14:01:54 -0700 |
commit | f8e05ca21197f878feddc867e77af4f7ebe26a12 (patch) | |
tree | 1c27e9d55cc4d7d669ce66ad55345625c0ffd132 /docs | |
parent | ed6d34338a6ac7311e0a3e5f756b7d212a85eedd (diff) |
Make some tweaks/improvements to conf docs (#10528)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/configure/common-changes.md | 20 | ||||
-rw-r--r-- | docs/guides/configure/performance.md | 21 |
2 files changed, 26 insertions, 15 deletions
diff --git a/docs/configure/common-changes.md b/docs/configure/common-changes.md index 79faae9876..6749384acd 100644 --- a/docs/configure/common-changes.md +++ b/docs/configure/common-changes.md @@ -68,11 +68,11 @@ each alarm and notification method is completely customizable. To create a new alarm configuration file, initiate an empty file, with a filename that ends in `.conf`, in the `health.d/` directory. The Netdata Agent loads any valid alarm configuration file ending in `.conf` in that directory. -Next, edit the new file with `edit-config`. For example, with a file called `ram-usage.conf`. +Next, edit the new file with `edit-config`. For example, with a file called `example-alarm.conf`. ```bash -sudo touch health.d/ram-usage.conf -sudo ./edit-config health.d/ram-usage.conf +sudo touch health.d/example-alarm.conf +sudo ./edit-config health.d/example-alarm.conf ``` 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. To see which configuration file you need to edit to configure a specific alarm, [view your active alarms](/docs/monitor/view-active-alarms.md) in Netdata Cloud or the local Agent dashboard and look for the **source** -line. For example, it might read `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. Because the source path contains -`health.d/cpu.conf`, you now you that you should run `sudo edit-config health.d/cpu.conf` to configure that alarm. +line. For example, it might read `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. + +Because the source path contains `health.d/cpu.conf`, run `sudo edit-config health.d/cpu.conf` to configure that alarm. ### Disable a specific alarm Open the configuration file for that alarm and set the `to` line to `silent`. +```conf +template: disk_fill_rate + on: disk.space + lookup: max -1s at -30m unaligned of avail + calc: ($this - $avail) / (30 * 60) + every: 15s + to: silent +``` + ### Turn of all alarms and notifications Set `enabled` to `no` in the [`[health]` section](/daemon/config/README.md#health-section-options) section of diff --git a/docs/guides/configure/performance.md b/docs/guides/configure/performance.md index e542736a1d..5f93a8cd42 100644 --- a/docs/guides/configure/performance.md +++ b/docs/guides/configure/performance.md @@ -66,7 +66,7 @@ seconds, respectively. ```conf [global] - update every: 5 + update every = 5 ``` ### Specific plugin or collector @@ -128,6 +128,7 @@ sudo ./edit-config charts.d.conf For example, to disable a few Python collectors: ```conf +modules: apache: no dockerd: no fail2ban: no @@ -149,9 +150,9 @@ All the settings are found in the `[global]` section of `netdata.conf`: ```conf [global] - memory mode = dbengine - page cache size = 32 - dbengine multihost disk space = 256 + memory mode = dbengine + page cache size = 32 + dbengine multihost disk space = 256 ``` ## Run Netdata behind Nginx @@ -194,15 +195,15 @@ To disable gzip compression, open `netdata.conf` and find the `[web]` section: ```conf [web] - enable gzip compression = no + enable gzip compression = no ``` Or to lower the default compression level: ```conf [web] - enable gzip compression = yes - gzip compression level = 1 + enable gzip compression = yes + gzip compression level = 1 ``` ## Disable logs @@ -212,9 +213,9 @@ If you installation is working correctly, and you're not actively auditing Netda ```conf [global] - debug log = none - error log = none - access log = none + debug log = none + error log = none + access log = none ``` ## What's next? |