summaryrefslogtreecommitdiffstats
path: root/health
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-01-30 05:46:55 -0700
committerGitHub <noreply@github.com>2020-01-30 05:46:55 -0700
commit3ddadb97035161f37efc59372306cb46de3c0c3c (patch)
tree95ce3235fcf987b2a853b79c6edb742ee62375b9 /health
parent7e6a6bef0798248ce2cde4a166e7bc3d1f4791c5 (diff)
Clarify editing health config files in health quickstart (#7883)
* Add fixes to health quickstart * Add notice about EDITOR and fix link
Diffstat (limited to 'health')
-rw-r--r--health/QUICKSTART.md63
-rw-r--r--health/tutorials/stop-notifications-alarms.md4
2 files changed, 37 insertions, 30 deletions
diff --git a/health/QUICKSTART.md b/health/QUICKSTART.md
index 2aa48efb8b..39ffcdb047 100644
--- a/health/QUICKSTART.md
+++ b/health/QUICKSTART.md
@@ -8,18 +8,43 @@ To learn about more advanced health configurations, visit the [health reference
## What's in this getting started guide
-- [Locate health configuration files](#locate-health-configuration-files)
-- [Edit existing health configuration files](#edit-existing-health-configuration-files)
+- [Edit health configuration files](#edit-health-configuration-files)
+- [Reference Netdata's stock health configuration files](#reference-netdatas-stock-health-configuration-files)
- [Write a new health entity](#write-a-new-health-entity)
- [Reload health configuration](#reload-health-configuration)
-## Locate health configuration files
+## Edit health configuration files
-By default, Netdata will put health configuration files in `/usr/lib/netdata/conf.d/health.d`.
+You should use `edit-config` to edit Netdata's health configuration files. `edit-config` will open your system's default
+terminal editor for you to make your changes. Once you've saved and closed the editor, `edit-config` will copy your
+edited file into `/etc/netdata/health.d/`, which will override the stock file in `/usr/lib/netdata/conf.d/health.d/` and
+ensure your customizations are persistent between updates.
-However, you can double-check the location of these files by navigating to `http://HOST:19999/netdata.conf` in your
-browser and looking for the `stock health configuration directory` option. The value here will show the correct path for
-your installation.
+For example, to edit the `cpu.conf` health configuration file, you would run:
+
+```bash
+cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /etc/netdata/
+./edit-config health.d/cpu.conf
+```
+
+> You may need to use `sudo` or another method of elevating your privileges: `sudo ./edit-config health.d/cpu.conf`.
+>
+> You can also use the `$EDITOR` environment variable to use your preferred terminal editor with `edit-config`. See
+> [this page](../docs/step-by-step/step-04.md#use-edit-config-to-open-netdataconf) for details.
+
+Each health configuration file contains one or more health entities, which always begin with an `alarm:` or `template:`
+line. You can edit these entities based on your needs. To make any changes live, be sure to [reload your health
+configuration](#reload-health-configuration).
+
+## Reference Netdata's stock health configuration files
+
+While you should always [use `edit-config`](#edit-health-configuration-files), you might also want to view the stock
+health configuration files Netdata ships with. Stock files can be useful as reference material, or to determine which
+file you should edit with `edit-config`.
+
+By default, Netdata will put health configuration files in `/usr/lib/netdata/conf.d/health.d`. However, you can
+double-check the location of these files by navigating to `http://HOST:19999/netdata.conf` in your browser and looking
+for the `stock health configuration directory` option. The value here will show the correct path for your installation.
```conf
[health]
@@ -27,7 +52,7 @@ your installation.
# stock health configuration directory = /usr/lib/netdata/conf.d/health.d
```
-Navigate to the health configuration directory to see all the available files.
+Navigate to the health configuration directory to see all the available files and open them for reading.
```bash
cd /usr/lib/netdata/conf.d/health.d/
@@ -38,26 +63,8 @@ apache.conf fronius.conf mysql.conf swap.conf
...
```
-## Edit existing health configuration files
-
-You should use `edit-config` to edit Netdata's health configuration files.
-
-For example, to edit the `cpu.conf` health configuration file, you would run:
-
-```bash
-cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /etc/netdata/
-./edit-config health.d/cpu.conf
-```
-
-> You may need to use `sudo` or another method of elevating your privileges.
-
-`edit-config` will open a text editor for you to make your changes. Once you've saved and closed the editor,
-`edit-config` will copy your edited file into `/etc/netdata/health.d/`, and it will now override the default in
-`/usr/lib/netdata/conf.d/health.d/`.
-
-Each health configuration file contains one or more health entities, which always begin with an `alarm:` or `template:`
-line. You can edit these entities based on your needs. To make any changes live, be sure to [reload your health
-configuration](#reload-health-configuration).
+> ⚠️ If you edit configuration files in your stock health configuration directory, Netdata will overwrite them during
+> any updates. Please use `edit-config` as described in the [section above](#edit-health-configuration-files).
## Write a new health entity
diff --git a/health/tutorials/stop-notifications-alarms.md b/health/tutorials/stop-notifications-alarms.md
index a616bf46a1..721705e741 100644
--- a/health/tutorials/stop-notifications-alarms.md
+++ b/health/tutorials/stop-notifications-alarms.md
@@ -28,8 +28,8 @@ In the `source` row, you see that this chart is getting its configuration from
`4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. The relevant part of begins at `health.d`: `health.d/cpu.conf`. That's
the file you need to edit if you want to silence this alarm.
-For more information about locating health configuration files on your system, see the [health
-quickstart](../QUICKSTART.md#locate-health-configuration-files).
+For more information about editing or referencing health configuration files on your system, see the [health
+quickstart](../QUICKSTART.md#edit-health-configuration-files).
## Edit the file to enable silencing