runreporter 0.2.1

Library for logging runtime errors and sending execution reports via Telegram and Email

runreporter

Библиотека для логирования ошибок и отправки отчетов по завершению выполнения.

Возможности:

• Логирование в файл
• Сбор последних 300 строк лога в отчет
• Отправка отчетов в Telegram (по chat_id)
• Отправка отчетов на Email (SMTP)
• Флаги: отправлять ли отчеты при отсутствии ошибок; приоритетный канал (Telegram/Email)

Установка

pip install .

Примеры использования

Вариант 1: через контекстный менеджер (with)

from runreporter import ErrorManager, SmtpConfig

manager = ErrorManager(
    log_file_path="app.log",
    telegram_bot_token="123:ABC",
    telegram_chat_ids=[11111111, 22222222],
    smtp_config=SmtpConfig(
        host="smtp.example.com",
        port=465,
        username="[e-mail]",
        password="pass",
        use_ssl=True,
        from_addr="[e-mail]",
    ),
    email_recipients=["[e-mail]", "[e-mail]"],
    send_reports_without_errors=False,
    primary_channel="telegram",  # "telegram" или "email"
)

with manager.context(run_name="Ежедневный импорт") as log:
    log.info("Начало работы")
    # ваш код
    log.error("Ошибка обработки записи id=42")

Вариант 2: без with (явный старт и финиш)

from runreporter import ErrorManager, SmtpConfig

manager = ErrorManager(
    log_file_path="app.log",
    telegram_bot_token="123:ABC",
    telegram_chat_ids=[11111111],
    smtp_config=SmtpConfig(
        host="smtp.example.com",
        port=465,
        username="[e-mail]",
        password="pass",
        use_ssl=True,
    ),
    email_recipients=["[e-mail]"],
    send_reports_without_errors=False,
    primary_channel="email",
)

log = manager.get_logger(run_name="Ночной job")

try:
    log.info("Старт job")
    # ваш код
    raise RuntimeError("Пример ошибки")
except Exception:
    log.exception("Произошло исключение")
finally:
    manager.send_report()  # можно передать run_name вручную

Вариант 3: локальный контекст сообщений

log = manager.get_logger(run_name="ETL")

log.info("Подготовка")
with manager.error_context("Загрузка CSV"):
    log.info("Читаю файл")
    log.error("Ошибка парсинга")  # сообщение будет помечено как [ETL > Загрузка CSV]
log.info("Финиш")

Конфигурация

• send_reports_without_errors: если False, отчеты будут отправляться только при наличии ошибок
• primary_channel: "telegram" или "email" — приоритет канала; второй используется как резервный

Лицензия

MIT