Update docs on telegram implementation

Author: richardgreg

README.md

@@ -33,7 +33,7 @@ To use the template, run the following command(s):
 
 1. Create local config file (`config.env`) to store all necessary environmental variables. There's already an example `config.env.template` in the repo that stores default env vars.
 
-2. [Download](https://go.dev/doc/install) or upgrade to `golang 1.19`.
+2. [Download](https://go.dev/doc/install) or upgrade to `golang 1.21`.
 
 3. Install all project golang dependencies by running `go mod download`.
 

alerts-template.yaml

@@ -7,8 +7,8 @@ alertRoutes:
         channel: ""
     telegram:
       low_oncall:
-        bot_token: ""
-        chat_id: ""
+        telegram_bot_token: ""
+        telegram_chat_id: ""
 
   medium:
     slack:
@@ -21,8 +21,8 @@ alertRoutes:
         integration_key: ""
     telegram:
       medium_oncall:
-        bot_token: ""
-        chat_id: ""
+        telegram_bot_token: ""
+        telegram_chat_id: ""
 
   high:
     slack:
@@ -36,5 +36,5 @@ alertRoutes:
         integration_key: ""
     telegram:
       high_oncall:
-        bot_token: ""
-        chat_id: ""
+        telegrambot_token: ""
+        telegram_chat_id: ""

config.env.template

@@ -18,7 +18,7 @@ BOOTSTRAP_PATH=genesis.json
 SERVER_HOST=localhost
 SERVER_PORT=8080
 SERVER_KEEP_ALIVE_TIME=10
-SERVER_READ_TIMEOUT=10 
+SERVER_READ_TIMEOUT=10
 SERVER_WRITE_TIMEOUT=10
 SERVER_SHUTDOWN_TIME=10
 

docs/alert-routing.md

@@ -37,6 +37,7 @@ Pessimism currently supports the following alert destinations:
 | slack     | Sends alerts to a Slack channel                   |
 | pagerduty | Sends alerts to a PagerDuty service               |
 | sns       | Sends alerts to an SNS topic defined in .env file |
+| telegram  | Sends alerts to a Telegram channel                |
 
 ## Alert Severity
 
@@ -58,6 +59,15 @@ topic. The ARN should be added to the `SNS_TOPIC_ARN` variable found in the `.en
 The AWS_ENDPOINT is optional and is primarily used for testing with localstack.
 > Note: Currently, Pessimism only support one SNS topic to publish alerts to.
 
+## Publishing to a Telegram Channel
+
+It's possible to publish alerts to a Telegram channel by adding the channel's
+ID and bot token to the `telegram_bot_token` and `telegram_bot_token`
+variables in the `alerts-routing.` configuration file. Generate a bot token by leveraging the
+following [guide](https://core.telegram.org/bots#how-do-i-create-a-bot).
+
+> Note: Currently, Pessimism only support one Telegram channel to publish alerts to.
+
 ## PagerDuty Severity Mapping
 
 PagerDuty supports the following severities: `critical`, `error`, `warning`,