From 13253c86926ed05688bdebec311c09a2f30ac822 Mon Sep 17 00:00:00 2001 From: Simon Pasquier Date: Thu, 18 Jun 2020 14:52:39 +0200 Subject: [PATCH] docs: document alert's fingerprint (#2308) Signed-off-by: Simon Pasquier --- docs/configuration.md | 3 ++- docs/notifications.md | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index 429e9ad1..f1643ec0 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -679,7 +679,8 @@ endpoint: "annotations": , "startsAt": "", "endsAt": "", - "generatorURL": // identifies the entity that caused the alert + "generatorURL": , // identifies the entity that caused the alert + "fingerprint": // fingerprint to identify the alert }, ... ] diff --git a/docs/notifications.md b/docs/notifications.md index 29462338..ecf8d77c 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -46,6 +46,7 @@ The `Alerts` type exposes functions for filtering alerts: | StartsAt | time.Time | The time the alert started firing. If omitted, the current time is assigned by the Alertmanager. | | EndsAt | time.Time | Only set if the end time of an alert is known. Otherwise set to a configurable timeout period from the time since the last alert was received. | | GeneratorURL | string | A backlink which identifies the causing entity of this alert. | +| Fingerprint | string | Fingerprint that can be used to identify the alert. | ## KV