Commit a376de56 by Carl Bergquist Committed by GitHub

Merge pull request #11934 from liquidm/improve_alert_docs

Improve alert docs
parents cebae404 c09c00a1
...@@ -49,18 +49,15 @@ Content-Type: application/json ...@@ -49,18 +49,15 @@ Content-Type: application/json
{ {
"id": 1, "id": 1,
"dashboardId": 1, "dashboardId": 1,
"dashboardUId": "ABcdEFghij"
"dashboardSlug": "sensors",
"panelId": 1, "panelId": 1,
"name": "fire place sensor", "name": "fire place sensor",
"message": "Someone is trying to break in through the fire place",
"state": "alerting", "state": "alerting",
"message": "Someone is trying to break in through the fire place",
"newStateDate": "2018-05-14T05:55:20+02:00",
"evalDate": "0001-01-01T00:00:00Z", "evalDate": "0001-01-01T00:00:00Z",
"evalData": [ "evalData": null,
{
"metric": "fire",
"tags": null,
"value": 5.349999999999999
}
"newStateDate": "2016-12-25",
"executionError": "", "executionError": "",
"url": "http://grafana.com/dashboard/db/sensors" "url": "http://grafana.com/dashboard/db/sensors"
} }
...@@ -88,16 +85,35 @@ Content-Type: application/json ...@@ -88,16 +85,35 @@ Content-Type: application/json
{ {
"id": 1, "id": 1,
"dashboardId": 1, "dashboardId": 1,
"dashboardUId": "ABcdEFghij"
"dashboardSlug": "sensors",
"panelId": 1, "panelId": 1,
"name": "fire place sensor", "name": "fire place sensor",
"message": "Someone is trying to break in through the fire place",
"state": "alerting", "state": "alerting",
"newStateDate": "2016-12-25", "message": "Someone is trying to break in through the fire place",
"newStateDate": "2018-05-14T05:55:20+02:00",
"evalDate": "0001-01-01T00:00:00Z",
"evalData": "evalMatches": [
{
"metric": "movement",
"tags": {
"name": "fireplace_chimney"
},
"value": 98.765
}
],
"executionError": "", "executionError": "",
"url": "http://grafana.com/dashboard/db/sensors" "url": "http://grafana.com/dashboard/db/sensors"
} }
``` ```
**Important Note**:
"evalMatches" data is cached in the db when and only when the state of the alert changes
(e.g. transitioning from "ok" to "alerting" state).
If data from one server triggers the alert first and, before that server is seen leaving alerting state,
a second server also enters a state that would trigger the alert, the second server will not be visible in "evalMatches" data.
## Pause alert ## Pause alert
`POST /api/alerts/:id/pause` `POST /api/alerts/:id/pause`
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment