summaryrefslogtreecommitdiffstats
path: root/docs/monitor
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2021-01-07 09:53:10 -0700
committerGitHub <noreply@github.com>2021-01-07 09:53:10 -0700
commit0bb7a429b619bc68104983691e4f957482630787 (patch)
tree040bc96ddd98ac59d7e83235f2babccc01ecb636 /docs/monitor
parent3adf54ff452fbe8216b64dfce9c7ec04bc7a270b (diff)
Small updates, improvements, and housekeeping to docs (#10405)
* Fix Berkeley mentions * Add new collectors to list * Tweak Prometheus/OpenMetrics phrasing * Fix heading depth in performance guide * Clarify that exporting starts with Agent start * Clarify usage of edit-config with new files * Update images * service -> systemctl * Reverse systemctl order
Diffstat (limited to 'docs/monitor')
-rw-r--r--docs/monitor/configure-alarms.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/monitor/configure-alarms.md b/docs/monitor/configure-alarms.md
index 4575b03ea1..2a977955b8 100644
--- a/docs/monitor/configure-alarms.md
+++ b/docs/monitor/configure-alarms.md
@@ -22,7 +22,8 @@ files.
## Edit health configuration files
All of Netdata's [health configuration files](/health/REFERENCE.md#health-configuration-files) are in Netdata's config
-directory, inside the `health.d/` directory. Use Netdata's `edit-config` script to make changes to any of these files.
+directory, inside the `health.d/` directory. Navigate to your [Netdata config directory](/docs/configure/nodes.md) and
+use `edit-config` to make changes to any of these files.
For example, to edit the `cpu.conf` health configuration file, run:
@@ -75,13 +76,18 @@ your systems, containers, and applications work.
Read Netdata's [health reference](/health/REFERENCE.md#health-entity-reference) for a full listing of the format,
syntax, and functionality of health entities.
-To write a new health entity, use `edit-config` to create a new file inside of the `health.d/` directory.
+To write a new health entity into a new file, navigate to your [Netdata config directory](/docs/configure/nodes.md),
+then use `touch` to create a new file in the `health.d/` directory. Use `edit-config` to start editing the file.
+
+As an example, let's create a `ram-usage.conf` file.
```bash
-sudo ./edit-config health.d/example.conf
+sudo touch health.d/ram-usage.conf
+sudo ./edit-config health.d/ram-usage.conf
```
-For example, here is a health entity that triggers an alarm when a node's RAM usage rises above 80%:
+For example, here is a health entity that triggers a warning alarm when a node's RAM usage rises above 80%, and a
+critical alarm above 90%:
```yaml
alarm: ram_usage