Update alerting terminology #679
Conversation
|
A documentation preview will be available soon: |
| When group by fields are selected, but no documents are containing the selected field(s) within the given time range (of alert execution), then we can't determine the group(s). This is relevant when the alert condition is sensitive to a certain number of documents, and that number might be 0. To use an example, if we want to know that Host A has less than five documents matching a condition, but the host has stopped reporting logs for the entire duration we were querying, no alert is triggered. | ||
| When group by fields are selected, but no documents contain the selected field(s) within the given time range of when the alert is triggered, | ||
| then you can't determine the group(s). This is relevant when the rule condition is sensitive to a certain number of documents, and | ||
| that number might be `0`. For example, if you want to know that `Host A` has less than five documents matching a condition, |
There was a problem hiding this comment.
I had a little trouble parsing the sentence that begins "For example, if you want ..." Maybe rephrase. Also, should. it say we or you?
There was a problem hiding this comment.
@dedemorton After reading it again, yeah, it's hard to parse. Maybe this is clearer?
For example, an alert is not triggered if a host has stopped reporting logs for the duration of the query.
|
|
||
| - `context.group`: This variable resolves to the **group** that the rule conditions detected. | ||
| For Inventory rules, this is the name of a monitored host, pod, container, etc. For metric threshold rules, |
There was a problem hiding this comment.
| For Inventory rules, this is the name of a monitored host, pod, container, etc. For metric threshold rules, | |
| For Inventory rules, this is the name of a monitored host, pod, container, and so on. For metric threshold rules, |
|
Question: does it make sense to update all of these if some didn't make it into 7.13? I don't know 🤷 . I ask because I'm running BC8 and it looks like only some apps have updated to the new terminology. For example, Uptime hasn't: But Metrics has: Even weirder, you select "Create Alert" in a dropdown, only to be taken to a page that says "Create Rule" |
|
@bmorelli25 Yeah the terminology does seem a little disjointed, especially for the Settings pages. For the Uptime settings page, I have kept it generic; |
|
👍 Got it, thanks! |
| @@ -32,34 +32,34 @@ data outside of this pattern. | |||
| image::images/heartbeat-indices.png[Heartbeat indices] | |||
|
|
|||
| [[configure-uptime-alert-connectors]] | |||
| == Configure alert connectors | |||
| == Configure connectors | |||
There was a problem hiding this comment.
Nice. I think this works well until Uptime migrates away from the deprecated alerting API. There's an issue in Kibana somewhere...
There was a problem hiding this comment.
Thanks for letting me know.
* Update alerting terminology * Review edits
* Update alerting terminology * Review edits
Summary
This PR updates the terminology used for alerting. An alert is the actual instance of the alert and a rule is the set of conditions that are checked periodically to trigger the alert.
Still to do: update the APM app docs.
Docs preview
Related issue
#443