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
thiagoftsm committed
Feb 8, 2020 at 23:30 UTC
34eb614697e0e26773122e4d8b348428c239c5d8
2 files changed
+6
-2
health/QUICKSTART.md
+4
-1
@@ -94,7 +94,10 @@ lookup: average -1m percentage of used
94
95
Let's look into each of the lines to see how they create a working health entity.
96
97
-- `alarm`: The name for your new entity. The name can be anything, but the only symbols allowed are `.` and `_`.
97
+- `alarm`: The name for your new entity. The name needs to follow these requirements:
98
+ - Any alphabet letter or number.
99
+ - The symbols `.` and `_`.
100
+ - Cannot be `chart name`, `dimension name`, `family name`, or `chart variable names`.
101
- `on`: Which chart the entity listens to.
102
- `lookup`: Which metrics the alarm monitors, the duration of time to monitor, and how to process the metrics into a
103
usable format.
health/REFERENCE.md
+2
-1
@@ -88,7 +88,8 @@ alarm: NAME
88
template: NAME
89
```
90
91
-`NAME` can be anything, with `.` (period) and `_` (underscore) as the only allowed symbols.
91
+`NAME` can be any alpha character, with `.` (period) and `_` (underscore) as the only allowed symbols, but the names
92
+cannot be `chart name`, `dimension name`, `family name`, or `chart variables names`.
93
94
#### Alarm line `on`
95