summaryrefslogtreecommitdiffstats
path: root/health/REFERENCE.md
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-08-19 08:04:47 -0700
committerGitHub <noreply@github.com>2020-08-19 08:04:47 -0700
commitc177910666871afd86e8284c73c59a03370de6b5 (patch)
tree031a918115036958465985b0d09d4ad90fd69fa1 /health/REFERENCE.md
parent2a798ad5510008abcb3949d17d97ddaa6d2801b8 (diff)
Docs: Add daemon config to health section and standardize IP references (#8837)
* Fix Chris' bug and cleanup * Fixes for Thiago * Fixes for Thiago * Rephrase the health files bullets * Fix in quickstart for Thiago * Fix path * Fix broken link
Diffstat (limited to 'health/REFERENCE.md')
-rw-r--r--health/REFERENCE.md49
1 files changed, 24 insertions, 25 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md
index 8150c8b9ad..d7809b5be4 100644
--- a/health/REFERENCE.md
+++ b/health/REFERENCE.md
@@ -1,8 +1,8 @@
<!--
---
title: "Health configuration reference"
-date: 2020-03-31
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/REFERENCE.md
+date: 2020-04-27
+custom_edit_url: <https://github.com/netdata/netdata/edit/master/health/REFERENCE.md>
---
-->
@@ -13,28 +13,26 @@ Welcome to the health configuration reference.
This guide contains information about editing health configuration files to tweak existing alarms or create new health
entities that are customized to the needs of your infrastructure.
-To learn the basics of locating and editing health configuration files, see the [health quickstart](QUICKSTART.md).
+To learn the basics of locating and editing health configuration files, see the [health
+quickstart](/health/QUICKSTART.md).
-## What's in this reference guide
+## Health configuration files
-- [Health entity reference](#health-entity-reference)
- - [Entity types](#entity-types)
- - [Entity format](#entity-format)
-- [Expressions](#expressions)
- - [Special use of the conditional operator](#special-use-of-the-conditional-operator)
-- [Variables](#variables)
-- [Alarm statuses](#alarm-statuses)
-- [Example alarms](#example-alarms)
-- [Troubleshooting](#troubleshooting)
-- [Disabling health checks or silencing notifications at runtime](#disabling-health-checks-or-silencing-notifications-at-runtime)
+You can configure the Agent's health watchdog service by editing files in two locations:
+
+- The `[health]` section in `netdata.conf`. By editing the daemon's behavior, you can disable health monitoring
+ altogether, run health checks more or less often, and more. See [daemon
+ configuration](/daemon/config/README.md#health-section-options) for a table of all the available settings, their
+ default values, and what they control.
+- The individual `.conf` files in `health.d/`. These health entitiy files are organized by the type of metric they are
+ performing calculations on or their associated collector. You should edit these files using the `edit-config`
+ script. For example: `sudo ./edit-config health.d/cpu.conf`.
## Health entity reference
The following reference contains information about the syntax and options of _health entities_, which Netdata attaches
to charts in order to trigger alarms.
-Entities are written into `.conf` files, inside of the `health.d/` directory, using YAML formatting.
-
### Entity types
There are two entity types: **alarms** and **templates**. They have the same format and feature set—the only difference
@@ -483,8 +481,9 @@ Which in turn, results in the following behavior:
## Variables
You can find all the variables that can be used for a given chart, using
-`http://your.netdata.ip:19999/api/v1/alarm_variables?chart=CHART_NAME` Example: [variables for the `system.cpu` chart of
-the registry](https://registry.my-netdata.io/api/v1/alarm_variables?chart=system.cpu).
+`http://NODE:19999/api/v1/alarm_variables?chart=CHART_NAME`, replacing `NODE` with the IP address or hostname for your
+Agent dashboard. For example, [variables for the `system.cpu` chart of the
+registry](https://registry.my-netdata.io/api/v1/alarm_variables?chart=system.cpu).
> If you don't know how to find the CHART_NAME, you can read about it [here](../web/README.md#charts).
@@ -746,21 +745,21 @@ Netdata will create alarms for all dimensions of the chart.
## Troubleshooting
-You can compile Netdata with [debugging](../daemon/README.md#debugging) and then set in `netdata.conf`:
+You can compile Netdata with [debugging](/daemon/README.md#debugging) and then set in `netdata.conf`:
```yaml
[global]
debug flags = 0x0000000000800000
```
-Then check your `/var/log/netdata/debug.log`. It will show you how it works.
-Important: this will generate a lot of output in debug.log.
+Then check your `/var/log/netdata/debug.log`. It will show you how it works. Important: this will generate a lot of
+output in debug.log.
-You can find the context of charts by looking up the chart in either
-`http://your.netdata:19999/netdata.conf` or `http://your.netdata:19999/api/v1/charts`.
+You can find the context of charts by looking up the chart in either `http://NODE:19999/netdata.conf` or
+`http://NODE:19999/api/v1/charts`, replacing `NODE` with the IP address or hostname for your Agent dashboard.
You can find how Netdata interpreted the expressions by examining the alarm at
-`http://your.netdata:19999/api/v1/alarms?all`. For each expression, Netdata will return the expression as given in its
+`http://NODE:19999/api/v1/alarms?all`. For each expression, Netdata will return the expression as given in its
config file, and the same expression with additional parentheses added to indicate the evaluation flow of the
expression.
@@ -769,6 +768,6 @@ expression.
It's currently not possible to schedule notifications from within the alarm template. For those scenarios where you need
to temporary disable notifications (for instance when running backups triggers a disk alert) you can disable or silence
notifications are runtime. The health checks can be controlled at runtime via the [health management
-api](../web/api/health/).
+api](/web/api/health/README.md).
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fhealth%2Freference%2F&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)