LoggerBot

© N.Sikharulidze (https://ubix.pro/)

LoggerBot is a Telegram logging library that allows you to send log messages to one or multiple Telegram chats using a bot. It provides an easy-to-use interface for logging various types of messages and includes features like rate limiting and message queuing.

Table of Contents

• Features
• Examples
• Installation
• Usage
  • Basic Usage
  • Advanced Usage
    • Rate Limiting
    • Setting Log Level
    • Using with Python's logging module
    • HTML Formatting for Log Messages
• Register a Telegram Bot
• Contributing
• License

Features

• Send log messages to one or multiple Telegram chats
• Support for different log levels: debug, info, warning, error, critical, alert, and complete
• Rate limiting to prevent excessive API calls
• Message queuing for smooth operation
• Easy integration with existing Python logging
• Backward compatibility with the LogBot alias
• HTML formatting support for log messages

Examples

HTML Formatting log example

Regular log examples

Installation

You can install LoggerBot using pip:

pip install loggerbot

Pypi.org (https://pypi.org/project/loggerbot/)

Usage

Here's a basic example of how to use LoggerBot:

from loggerbot import TelegramLoggingBot

# Initialize the bot with your Telegram bot token and chat ID(s)
log_bot = TelegramLoggingBot("YOUR_BOT_TOKEN", ["CHAT_ID_1", "CHAT_ID_2"])

# Send log messages
log_bot.info("This is an informational message")
log_bot.warning("This is a warning message")
log_bot.error("An error occurred")
log_bot.alert("This is an important alert")
log_bot.complete("Task completed successfully")

Advanced Usage

Rate Limiting

LoggerBot includes built-in rate limiting to prevent excessive API calls. You can customize the rate limit when initializing the bot:

log_bot = TelegramLoggingBot("YOUR_BOT_TOKEN", "CHAT_ID", rate_limit=20, time_window=60)

This sets a limit of 20 messages per 60 seconds.

Setting Log Level

You can set the minimum log level for the bot:

import logging
log_bot.set_log_level(logging.DEBUG)

Using with Python's logging module

LoggerBot can be integrated with Python's built-in logging module:

import logging
from loggerbot import TelegramLoggingBot

# Create a logger
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)

# Create a TelegramLoggingBot instance
tg_handler = TelegramLoggingBot("YOUR_BOT_TOKEN", "CHAT_ID")

# Add the TelegramLoggingBot as a handler to the logger
logger.addHandler(tg_handler)

# Now you can use the logger as usual
logger.info("This message will be sent to Telegram")

HTML Formatting for Log Messages

LoggerBot supports HTML formatting in log messages, allowing you to enhance the readability and structure of your logs in Telegram. Here are some examples of how to use HTML formatting:

# Bold text
log_bot.info("This is an <b>important</b> message")

# Italic text
log_bot.warning("Please <i>be cautious</i> when proceeding")

# Code formatting
log_bot.error("An error occurred: <code>ValueError: Invalid input</code>")

# Underlined text
log_bot.alert("This requires <u>immediate attention</u>")

# Combining multiple formats
log_bot.complete("Task <b><i>successfully</i></b> completed")

# Using line breaks
log_bot.info("This is a multi-line message.<br>It has two lines.")

# Creating a list
log_bot.info("Steps to reproduce:<br>1. Open the app<br>2. Click on settings<br>3. Select 'Advanced'")

# Adding a hyperlink
log_bot.info("For more information, visit our <a href='https://example.com'>documentation</a>")

Note: Make sure to use HTML entities for special characters like < (<), > (>), and & (&) when they're not part of HTML tags.

Register a Telegram Bot

To register a Telegram bot and obtain an API key, follow these steps:

1. Open the Telegram app and search for BotFather.
2. Start a chat with BotFather and use the /newbot command to create a new bot.
3. Follow the instructions to name your bot and get a unique username.
4. Once your bot is created, you will receive a Bot Token. This token is used to authenticate your bot with the Telegram API.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.