{"id":15950078,"url":"https://github.com/ivanhercaz/tower_telegram","last_synced_at":"2025-03-17T23:32:25.615Z","repository":{"id":257812348,"uuid":"867883208","full_name":"ivanhercaz/tower_telegram","owner":"ivanhercaz","description":"Elixir error tracking and reporting with a Telegram bot","archived":false,"fork":false,"pushed_at":"2024-10-06T15:13:52.000Z","size":42,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-10T16:47:45.995Z","etag":null,"topics":["elixir","error-monitoring","error-reporting","error-tracking","telegram-notification","tower"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ivanhercaz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-04T23:25:16.000Z","updated_at":"2025-01-10T13:00:16.000Z","dependencies_parsed_at":"2024-10-07T12:57:58.996Z","dependency_job_id":null,"html_url":"https://github.com/ivanhercaz/tower_telegram","commit_stats":null,"previous_names":["ivanhercaz/tower_telegram"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhercaz%2Ftower_telegram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhercaz%2Ftower_telegram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhercaz%2Ftower_telegram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhercaz%2Ftower_telegram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivanhercaz","download_url":"https://codeload.github.com/ivanhercaz/tower_telegram/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243893413,"owners_count":20364896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","error-monitoring","error-reporting","error-tracking","telegram-notification","tower"],"created_at":"2024-10-07T12:57:58.084Z","updated_at":"2025-03-17T23:32:25.337Z","avatar_url":"https://github.com/ivanhercaz.png","language":"Elixir","readme":"# TowerTelegram\n\n[![Hex.pm Version](https://img.shields.io/hexpm/v/tower_telegram)](https://hex.pm/packages/tower_telegram) [![Documentation](https://img.shields.io/badge/-Documentation-blueviolet)](https://hexdocs.pm/tower_telegram) [![CI](https://github.com/ivanhercaz/tower_telegram/actions/workflows/ci.yml/badge.svg)](https://github.com/ivanhercaz/tower_telegram/actions/workflows/ci.yml)\n\nError tracking and reporting to a Telegram chat (group or channel) using [Tower][tower].\n\nIt is a work-in-progress heavily inspired in the already existing [`TowerEmail`][tower-email] structure, but using Telegram and [`telegex`][telegex].\n\n## Requirements\n\nIn order to use this reporter you must have a Telegram bot and provide your bot token and the chat ID (group or channel) in which you need to receive the reports.\n\nIf you don't have or you don't know how to create a Telegram bot, first check [*How Do I Create a Bot*](https://core.telegram.org/bots#how-do-i-create-a-bot) Telegram's page.\n\n## Configuration\n\nThis reporter uses `Telegex` for the communication with the bot. In order to use a Telegram bot, it is necessary\nto specify the bot token for `Telegex`:\n\n```elixir\nconfig :telegex, token: \"\u003cBOT_TOKEN\u003e\"\n```\n\nIn addition you must specify your preferred adapter for the HTTP client. At the moment of writting this, Telegex\nsupports `Finch` (recommended) and `HTTPoison`:\n\n```elixir\n# With Finch\nconfig :telegex, caller_adapter: Finch\n\n# With HTTPoison\nconfig :telegex, caller_adapter: HTTPoison\n```\n\nCheck [Telegex's Configuration section][telegex-config] for more options and information.\n\nYou must also add the `chat_id` in which you want to receive the reports:\n\n```elixir\nconfig :tower_telegram, chat_id: \u003cchat_id\u003e\n```\n\nFinally, you must register the reporter in `tower` reporters list:\n\n```elixir\nconfig :tower, :reporters, [TowerTelegram]\n```\n\n### Note\n\nIf you are interested in use TowerTelegram but with another Telegram packages, please, first read [this issue][tower-telegram-packages] and then feel free to open a new one requesting! Or even a pull request implementing the one you desire.\n\n## Usage\n\nOnce you already have the reporter, it will listen the errors\nof your application as it is explained in [`Tower` documentation][tower-docs].\n\nIt is also possible to manually fire the reporter, check *Manual\nHandling* section of Tower's documentation.\n\n## Test your bot reporter\n\nOnce you have `TowerTelegram` configured, you can open `iex` and\ntest it using `Tower.test/0`.\n\n[telegex]: https://github.com/telegex/telegex\n\n[telegex-config]: https://github.com/telegex/telegex#configuration\n\n[tower]: https://github.com/mimiquate/tower\n\n[tower-docs]: https://hexdocs.pm/tower\n\n[tower-email]: https://github.com/mimiquate/tower_email\n\n[tower-telegram-packages]: https://github.com/ivanhercaz/tower_telegram/issues/2\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivanhercaz%2Ftower_telegram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivanhercaz%2Ftower_telegram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivanhercaz%2Ftower_telegram/lists"}