diff options
| author | Joel Hans <joel@netdata.cloud> | 2020-11-19 06:03:11 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-19 06:03:11 -0700 |
| commit | e074c3a8aeeba868c5adcd0e06ff6f1866de0b5f (patch) | |
| tree | 7cad14ee7850653813cbeabe5d74f6985c10c21c /health | |
| parent | 9f72979be43ae698ea2a3a38dc48407ce233699b (diff) | |
Docs: Point users to proper configure doc (#10254)
* Point users to proper configure doc
* Remove extra text
Diffstat (limited to 'health')
| -rw-r--r-- | health/QUICKSTART.md | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/health/QUICKSTART.md b/health/QUICKSTART.md index 83b94f17a8..bc91caf7c5 100644 --- a/health/QUICKSTART.md +++ b/health/QUICKSTART.md @@ -13,10 +13,10 @@ To learn about more advanced health configurations, visit the [health reference ## Edit health configuration files -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. +You should [use `edit-config`](/docs/configure/nodes.md) 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. For example, to edit the `cpu.conf` health configuration file, you would run: @@ -25,11 +25,6 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et ./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/guides/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). |