Skip to main content

🦜 A CLI tool to monitor a file and send updates to Telegram.

Project description

log2telegram

log2telegram is a CLI tool to monitor changes in a specified log file and send updates to a Telegram chat. This package allows you to stay informed about updates in critical logs or other files by sending new content as Telegram messages, with customizable options to filter color codes and timestamps.

Features

•	Real-Time Monitoring: Continuously watches for changes in a log file, sending new content as Telegram messages.
•	Configurable Delay: Set a custom interval for checking the file for changes.
•	Filtering Options: Remove ANSI color codes and timestamps at the start of lines for cleaner messages.
•	Customizable Message Splitting: Automatically splits messages if they exceed the Telegram message size limit.
•	Error Handling and Logging: Logs errors if the file is unreadable, ensuring smooth operation and easy debugging.

Installation

You can install the package via PyPI:

pip install log2telegram

Setup

To use log2telegram, add the following environment variables to a .env file:

LOG2TELEGRAM_BOT_TOKEN= LOG2TELEGRAM_CHAT_ID=

•	LOG2TELEGRAM_BOT_TOKEN: Your Telegram bot token, obtained from BotFather.
•	LOG2TELEGRAM_CHAT_ID: The chat ID where messages will be sent.

Usage

Run the log2telegram command to monitor a file for changes. You can specify the path to the file and set optional flags for filtering.

Command-Line Arguments

log2telegram [--seconds_delay SECONDS] [--filter-color-chars] [--filter-timestamps]

•	<file-path> (required): The path to the file to monitor.
•	--seconds_delay (optional): Interval in seconds between each check (default: 1). Must be a positive integer.
•	--filter-color-chars (optional): Removes ANSI color codes from lines before sending.
•	--filter-timestamps (optional): Removes timestamps at the start of lines.

Examples

1.	Basic Usage

Monitor a log file with a default polling delay of 1 second.

Example Workflow

1.	Start the program to monitor the specified file.
2.	Upon changes, new content is sent to the designated Telegram chat.
3.	If specified, color codes and timestamps are removed from each line before sending.

Requirements

•	Python 3.7+
•	Dependencies managed automatically upon installation.

License

This package is licensed under the MIT License.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests for improvements.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

log2telegram-0.5.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

log2telegram-0.5-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file log2telegram-0.5.tar.gz.

File metadata

  • Download URL: log2telegram-0.5.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.10

File hashes

Hashes for log2telegram-0.5.tar.gz
Algorithm Hash digest
SHA256 2546069e675dde1a5f19de1e664d19bd99b568a0c2fb6114d9304bbfc290694b
MD5 00da047b39b6d5c35a9ec25b83b36631
BLAKE2b-256 8e8b8d4843a937466df9faac82f67ce43fb11756a9a0ffd47c4ab51f3f1bbb5e

See more details on using hashes here.

File details

Details for the file log2telegram-0.5-py3-none-any.whl.

File metadata

  • Download URL: log2telegram-0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.10

File hashes

Hashes for log2telegram-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8f71ed85eb4f0b9ba30df267c96352e645b3d62c8e04db8862be3e30a5f5e894
MD5 43bf9e8f5d284b120bbc90c21341f335
BLAKE2b-256 292e14f6e8501f5f1931cdd48e3c2e3e9631a1130cc8cb6d369fd7f3cb97ea4e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page