Browse Source

add useful note to alerting api docs

Stuart McLean 7 years ago
parent
commit
295169b94f
1 changed files with 7 additions and 0 deletions
  1. 7 0
      docs/sources/http_api/alerting.md

+ 7 - 0
docs/sources/http_api/alerting.md

@@ -117,6 +117,13 @@ Content-Type: application/json
 }
 ```
 
+**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
 
 `POST /api/alerts/:id/pause`