diff options
| author | thiagoftsm <thiagoftsm@gmail.com> | 2020-02-08 23:30:40 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-08 15:30:40 -0800 |
| commit | 34eb614697e0e26773122e4d8b348428c239c5d8 (patch) | |
| tree | 0d3e722ef0d2606e2729158cf92fbe1edfd1216f | |
| parent | 9cf6f461e6fb04fb3bca14de5c54c3f65489a8a0 (diff) | |
health_doc_name: Clarify the rules to create an alarm name (#7911)
* health_doc_name: Clarify the rules to create an alarm name
* health_doc_name: Fixes typo and gramma
* health_doc_name: Fixes typo
| -rw-r--r-- | health/QUICKSTART.md | 5 | ||||
| -rw-r--r-- | health/REFERENCE.md | 3 |
2 files changed, 6 insertions, 2 deletions
diff --git a/health/QUICKSTART.md b/health/QUICKSTART.md index 39ffcdb047..3555e3cd22 100644 --- a/health/QUICKSTART.md +++ b/health/QUICKSTART.md @@ -94,7 +94,10 @@ lookup: average -1m percentage of used Let's look into each of the lines to see how they create a working health entity. -- `alarm`: The name for your new entity. The name can be anything, but the only symbols allowed are `.` and `_`. +- `alarm`: The name for your new entity. The name needs to follow these requirements: + - Any alphabet letter or number. + - The symbols `.` and `_`. + - Cannot be `chart name`, `dimension name`, `family name`, or `chart variable names`. - `on`: Which chart the entity listens to. - `lookup`: Which metrics the alarm monitors, the duration of time to monitor, and how to process the metrics into a usable format. diff --git a/health/REFERENCE.md b/health/REFERENCE.md index 5ddb65b485..7ae7d6301d 100644 --- a/health/REFERENCE.md +++ b/health/REFERENCE.md @@ -88,7 +88,8 @@ alarm: NAME template: NAME ``` -`NAME` can be anything, with `.` (period) and `_` (underscore) as the only allowed symbols. +`NAME` can be any alpha character, with `.` (period) and `_` (underscore) as the only allowed symbols, but the names +cannot be `chart name`, `dimension name`, `family name`, or `chart variables names`. #### Alarm line `on` |