Skip to content
This repository was archived by the owner on May 29, 2024. It is now read-only.

Commit a692c87

Browse files
committed
Add initial telegram alert documentation
1 parent d2bcad1 commit a692c87

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/alert-routing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Pessimism currently supports the following alert destinations:
3636
|-----------|-------------------------------------|
3737
| slack | Sends alerts to a Slack channel |
3838
| pagerduty | Sends alerts to a PagerDuty service |
39+
| pagerduty | Sends alerts to a PagerDuty service |
3940

4041
## Alert Severity
4142

docs/architecture/alerting.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,13 @@ subgraph AM["Alerting Manager"]
2929
EL --> |Submit alert|SR["SeverityRouter"]
3030
SR --> SH["Slack"]
3131
SR --> PH["PagerDuty"]
32+
SR --> TH["Telegram"]
3233
SR --> CPH["CounterParty Handler"]
3334

3435
end
3536
CPH --> |"HTTP POST"|TPH["Third Party API"]
3637
SH --> |"HTTP POST"|SlackAPI("Slack Webhook API")
38+
TH --> |"HTTP POST"|TelegramBotAPI("Telegram Bot API")
3739
PH --> |"HTTP POST"|PagerDutyAPI("PagerDuty API")
3840

3941
</div>
@@ -79,6 +81,8 @@ Done! You should now see any generated alerts being forwarded to your specified
7981

8082
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.
8183

84+
#### Telegram
85+
8286
### Alert CoolDowns
8387

8488
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.

0 commit comments

Comments
 (0)