Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koldim2001/tg_bot_kafka
Телеграмм бот, отправляющий в чаты сообщения, приходящие в kafka
https://github.com/koldim2001/tg_bot_kafka
aiogram aiogram-bot docker docker-compose dotenv kafka kafka-consumer telegram-bot
Last synced: 27 days ago
JSON representation
Телеграмм бот, отправляющий в чаты сообщения, приходящие в kafka
- Host: GitHub
- URL: https://github.com/koldim2001/tg_bot_kafka
- Owner: Koldim2001
- Created: 2024-05-27T13:23:15.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-25T18:09:18.000Z (about 1 month ago)
- Last Synced: 2024-12-25T19:18:37.239Z (about 1 month ago)
- Topics: aiogram, aiogram-bot, docker, docker-compose, dotenv, kafka, kafka-consumer, telegram-bot
- Language: Jupyter Notebook
- Homepage:
- Size: 13.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Телеграмм бот, отправляющий сообщения из Kafka
Этот бот выступает в качестве консьюмера Kafka топиков и отправляет сообщения в желаемые чаты, обеспечивая своевременную доставку информации. Он упрощает управление алертами и может функционировать как риалтайм отправитель сообщений, передающий важную информацию из других сервисов вашего микросервисного приложения.
Итоговый бот был собран и залит на докерхаб. Готовый образ можно стянуть следующей командой: `docker pull koldim2001/tg_bot_kafka:1.0`
Контейнер с ботом в вашем проекте может стать одним из сервисов, который можно будет удобно подключить в docker-compose.yaml
Пример докер компоуз файла, содержащего все необходимые иструменты (см файл [docker-compose.yaml](docker-compose.yaml) в репозитории), можно запустить данной командой:
```
docker-compose -p test_kafka up -d
```
Только перд запуском необходимо внести изменения в переменные окружения:
```
tg_bot_kafka:
image: koldim2001/tg_bot_kafka:1.0
container_name: tg_bot_kafka
restart: always
depends_on:
- kafka
environment:
- BOT_TOKEN=??????????????????????????????
- CHAT_IDS=["?????????"]
- KAFKA_BOOTSTRAP_SERVERS=kafka:29092
- KAFKA_TOPIC=tg_bot_data
- JSON_TO_YAML=TRUE
```
Пример необходимых переменных окружения для запуска проекта:
| Переменная окружения | Описание | Пример задания |
| --- | --- | --- |
| `BOT_TOKEN` | Токен бота, используемый для аутентификации в Telegram API. | `BOT_TOKEN=12345:ABCDEFGHIJKLMNOPQ` |
| `CHAT_IDS` | Список идентификаторов чатов, в которые бот будет отправлять сообщения. | `CHAT_IDS=["111111","222222"]` |
| `KAFKA_BOOTSTRAP_SERVERS` | Сервер Kafka, к которому будет подключаться бот для чтения сообщений. | `KAFKA_BOOTSTRAP_SERVERS=kafka:29092` |
| `KAFKA_TOPIC` | Топик Kafka, из которого бот будет читать сообщения. | `KAFKA_TOPIC=tg_bot_data` |
| `JSON_TO_YAML` | Флаг, определяющий, будут ли JSON сообщения преобразовываться в более читабельный вид перед отправкой в Telegram. Если `TRUE`, то сообщения будут преобразованы. Если `FALSE`, то сообщения будут отправлены ровно так, как и были посланы в Kafka. | `JSON_TO_YAML=TRUE` |
Чтобы узнать chat_id, необходимо после запуска компоуза добавить бота в желаемый чат и отправить в команду ```/info```. Бот выведет номер чата. Этот номер необходимо будет указать в переменных окружения перед запуском docker compose.
Помимо этого есть еще вариант Как узнать идентификатор chat_id без бота и кода - [ссылка](https://pikabu.ru/story/kak_uznat_identifikator_telegram_kanalachatagruppyi_kak_uznat_chat_id_telegram_bez_botov_i_koda_11099278)
---
Для тестирования работоспособности бота можно открыть джупитер ноутбук [simple_producer.ipynb](simple_producer.ipynb) и с помощью него создать топик и отправить сообщения в kafka (ноутбук выступает в качествае kafka producer)