diff --git a/docs/alert-routing.md b/docs/alert-routing.md index 10917adb..9bacb05e 100644 --- a/docs/alert-routing.md +++ b/docs/alert-routing.md @@ -36,6 +36,7 @@ Pessimism currently supports the following alert destinations: |-----------|-------------------------------------| | slack | Sends alerts to a Slack channel | | pagerduty | Sends alerts to a PagerDuty service | +| pagerduty | Sends alerts to a PagerDuty service | ## Alert Severity diff --git a/docs/architecture/alerting.markdown b/docs/architecture/alerting.markdown index 6097f6c6..a43a619f 100644 --- a/docs/architecture/alerting.markdown +++ b/docs/architecture/alerting.markdown @@ -29,11 +29,13 @@ subgraph AM["Alerting Manager"] EL --> |Submit alert|SR["SeverityRouter"] SR --> SH["Slack"] SR --> PH["PagerDuty"] + SR --> TH["Telegram"] SR --> CPH["CounterParty Handler"] end CPH --> |"HTTP POST"|TPH["Third Party API"] SH --> |"HTTP POST"|SlackAPI("Slack Webhook API") +TH --> |"HTTP POST"|TelegramBotAPI("Telegram Bot API") PH --> |"HTTP POST"|PagerDutyAPI("PagerDuty API") @@ -79,6 +81,8 @@ Done! You should now see any generated alerts being forwarded to your specified The PagerDuty alert destination is a configurable destination that allows alerts to be sent to a specific PagerDuty services via the use of integration keys. Pessimism also uses the UUID associated with an alert as a deduplication key for PagerDuty. This is done to ensure that PagerDuty will not be spammed with duplicate or incidents. +#### Telegram + ### Alert CoolDowns To ensure that alerts aren't spammed to destinations once invoked, a time based cooldown value (`cooldown_time`) can be defined within the `alert_params` of a heuristic session config. This time value determines how long a heuristic session must wait before being allowed to alert again.