Skip to content

N
nexpie-grafana-theme
Commit 51069c9c by Marcus Efraimsson
Options

docs: reminder notifications update

parent 34e448c6
Showing with 38 additions and 16 deletions
docs/sources/alerting/notifications.md
...@@ -42,9 +42,9 @@ should be sent using number of seconds (s), minutes (m) or hours (h), for exampl ...@@ -42,9 +42,9 @@ should be sent using number of seconds (s), minutes (m) or hours (h), for exampl
**Important:** Alert reminders are sent after rules are evaluated. Therefore a reminder can never be sent earlier than a configured [alert rule evaluation interval](/alerting/rules/#name-evaluation-interval). **Important:** Alert reminders are sent after rules are evaluated. Therefore a reminder can never be sent earlier than a configured [alert rule evaluation interval](/alerting/rules/#name-evaluation-interval).
These examples shows how often and when reminders are sent for a triggered alert. These examples show how often and when reminders are sent for a triggered alert.
Alert rule evaluation interval | Send reminders every | Reminder sent every (after last alerting notification) Alert rule evaluation interval | Send reminders every | Reminder sent every (after last alert notification)
---------- | ----------- | ----------- ---------- | ----------- | -----------
`30s` | `15s` | ~30 seconds `30s` | `15s` | ~30 seconds
`1m` | `5m` | ~5 minutes `1m` | `5m` | ~5 minutes
......
docs/sources/alerting/rules.md
...@@ -89,11 +89,9 @@ to fire if the rule already is in state `Alerting`. To improve support for queri ...@@ -89,11 +89,9 @@ to fire if the rule already is in state `Alerting`. To improve support for queri
we plan to track state **per series** in a future release. we plan to track state **per series** in a future release.
> Starting with Grafana v5.3 you can configure reminders to be sent for triggered alerts. This will send additional notifications > Starting with Grafana v5.3 you can configure reminders to be sent for triggered alerts. This will send additional notifications
> when an alert continues to fire. If other series cause the alert they'll be included in the reminder notification. Depending on > when an alert continues to fire. If other series (like server2 in the example above) also cause the alert rule to fire they will
> what notification channel you're using you may be able to take advantage of this feature for identifying new/existing series > be included in the reminder notification. Depending on what notification channel you're using you may be able to take advantage
> causing alert to fire. [Read more about notification reminders here](/alerting/notifications/#send-reminders). > of this feature for identifying new/existing series causing alert to fire. [Read more about notification reminders here](/alerting/notifications/#send-reminders).
>
> Please note that the track state **per series** feature still is needed for proper handling of notifications for multiple series.
### No Data / Null values ### No Data / Null values
......
docs/sources/http_api/alerting.md
...@@ -50,6 +50,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -50,6 +50,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```http ```http
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
[ [
{ {
"id": 1, "id": 1,
...@@ -86,6 +87,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -86,6 +87,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```http ```http
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"id": 1, "id": 1,
"dashboardId": 1, "dashboardId": 1,
...@@ -146,6 +148,7 @@ JSON Body Schema: ...@@ -146,6 +148,7 @@ JSON Body Schema:
```http ```http
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"alertId": 1, "alertId": 1,
"state": "Paused", "state": "Paused",
...@@ -177,6 +180,7 @@ JSON Body Schema: ...@@ -177,6 +180,7 @@ JSON Body Schema:
```http ```http
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"state": "Paused", "state": "Paused",
"message": "alert paused", "message": "alert paused",
...@@ -204,14 +208,21 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -204,14 +208,21 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ [
{
"id": 1, "id": 1,
"name": "Team A", "name": "Team A",
"type": "email", "type": "email",
"isDefault": true, "isDefault": false,
"created": "2017-01-01 12:45", "sendReminder": false,
"updated": "2017-01-01 12:45" "settings": {
} "addresses": "carl@grafana.com;dev@grafana.com"
},
"created": "2018-04-23T14:44:09+02:00",
"updated": "2018-08-20T15:47:49+02:00"
}
]
``` ```
## Create alert notification ## Create alert notification
...@@ -232,6 +243,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -232,6 +243,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
"name": "new alert notification", //Required "name": "new alert notification", //Required
"type": "email", //Required "type": "email", //Required
"isDefault": false, "isDefault": false,
"sendReminder": false,
"settings": { "settings": {
"addresses": "carl@grafana.com;dev@grafana.com" "addresses": "carl@grafana.com;dev@grafana.com"
} }
...@@ -243,14 +255,18 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -243,14 +255,18 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```http ```http
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"id": 1, "id": 1,
"name": "new alert notification", "name": "new alert notification",
"type": "email", "type": "email",
"isDefault": false, "isDefault": false,
"settings": { addresses: "carl@grafana.com;dev@grafana.com"} } "sendReminder": false,
"created": "2017-01-01 12:34", "settings": {
"updated": "2017-01-01 12:34" "addresses": "carl@grafana.com;dev@grafana.com"
},
"created": "2018-04-23T14:44:09+02:00",
"updated": "2018-08-20T15:47:49+02:00"
} }
``` ```
...@@ -271,6 +287,8 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -271,6 +287,8 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
"name": "new alert notification", //Required "name": "new alert notification", //Required
"type": "email", //Required "type": "email", //Required
"isDefault": false, "isDefault": false,
"sendReminder": true,
"frequency": "15m",
"settings": { "settings": {
"addresses: "carl@grafana.com;dev@grafana.com" "addresses: "carl@grafana.com;dev@grafana.com"
} }
...@@ -282,12 +300,17 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -282,12 +300,17 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```http ```http
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"id": 1, "id": 1,
"name": "new alert notification", "name": "new alert notification",
"type": "email", "type": "email",
"isDefault": false, "isDefault": false,
"settings": { addresses: "carl@grafana.com;dev@grafana.com"} } "sendReminder": true,
"frequency": "15m",
"settings": {
"addresses": "carl@grafana.com;dev@grafana.com"
},
"created": "2017-01-01 12:34", "created": "2017-01-01 12:34",
"updated": "2017-01-01 12:34" "updated": "2017-01-01 12:34"
} }
...@@ -311,6 +334,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -311,6 +334,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```http ```http
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"message": "Notification deleted" "message": "Notification deleted"
} }
......
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