2017 © Pedro Peláez
 

library monolog-telegram

Monolog handler that sends logs through Telegram bot to any chat in HTML format

image

jacklul/monolog-telegram

Monolog handler that sends logs through Telegram bot to any chat in HTML format

  • Tuesday, May 15, 2018
  • by jacklul
  • Repository
  • 2 Watchers
  • 2 Stars
  • 309 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 9 Versions
  • 28 % Grown

The README.md

Monolog Telegram Handler

Send your logs through Telegram bot to any chat and make them look fancy!, (*1)

Features:

  • Continous logging and batch logging support
  • Standard stack traces wrapped in <code></code> tags
  • Automatic splitting of the message when it exceeds maximum limit

Prerequisites

  • Telegram Bot API token - see here to learn how to obtain one
  • ID of the chat to which you want to send the logs - see below

Obtaining chat ID

One of the simplest ways to do that is to interact with the bot in the target chat: - private and group chats - send any dummy command - channels - post something in it, (*2)

After interacting visit https://api.telegram.org/botTOKEN/getUpdates (replace TOKEN with your actual bot token), you will be able to find the chat id (chat_id) in the result JSON., (*3)

Installation

Install with Composer:, (*4)

$ composer require jacklul/monolog-telegram

Usage

To use this handler you just have to add it like every other Monolog handler:, (*5)

require 'vendor/autoload.php';

$logger = new Logger('My project');
$handler = new TelegramHandler(
    '123456789:teMbvbETojnSG93jDhnynvH8pT28H9TIB1h',  // Bot API token
    987654321,  // Target Chat ID
    Logger::ERROR,  // Log level, default: DEBUG
    true,  // Bubble up the stack or not, default: true
    true,  // Use cURL or not? default: true = use when available
    10,    // Timeout for API requests, default: 10
    true   // Verify SSL certificate or not? default: true, false only useful for development - avoid in production
    2,     // (optional) Target Thread ID for group chats with Topics enabled
);

$handler->setFormatter(new TelegramFormatter());    // Usage of this formatter is optional but recommended if you want better message layout
$logger->pushHandler($handler);

$logger->error('Error!');

To prevent spamming the chat and hitting Telegram's API limits it is advised to use DeduplicationHandler and/or BufferHandler, ideal solution for production use would be:, (*6)

$handler = new TelegramHandler('TOKEN', 123456789);
$handler->setFormatter(new TelegramFormatter());

// Combine all log entries into one and force batch processing
$handler = new BufferHandler($handler);

// Make sure that particular log stack wasn't sent before
$handler = new DeduplicationHandler($handler);

// Keep collecting logs until ERROR occurs, after that send collected logs to $handler
$handler = new FingersCrossedHandler($handler, new ErrorLevelActivationStrategy(Logger::ERROR));

$logger->pushHandler($handler);

You can customize the formatter:, (*7)

$html = true;    // Choose whether to send the message in HTMl format
$format = "%emoji% <b>%level_name%</b> (%channel%) [%date%]\n\n%message%\n\n%context%%extra%";   // EMOJI ERROR (My project) [2018-05-01 15:55:15 UTC]
$date_format = 'Y-m-d H:i:s e';       // 2018-05-01 15:55:15 UTC, format must be supported by DateTime::format
$separator = '-';       // Seperation character for batch processing - when empty one empty line is used
$emojis = [         // Override any level emoji
    'NOTICE' => '🤖'
];

$handler->setFormatter(new TelegramFormatter($html, $format, $date_format, $separator, $emojis));

Running tests

Create .env file:, (*8)

TELEGRAM_TOKEN=BOT_TOKEN
TELEGRAM_CHAT_ID=CHAT_ID_THE_BOT_WILL_SPAM;

Run composer check-code and composer test., (*9)

License

See LICENSE., (*10)

The Versions

15/05 2018

dev-master

9999999-dev

Monolog handler that sends logs through Telegram bot to any chat in HTML format

  Sources   Download

MIT

The Requires

 

The Development Requires

log logging monolog bot telegram

15/05 2018

dev-develop

dev-develop

Monolog handler that sends logs through Telegram bot to any chat in HTML format

  Sources   Download

MIT

The Requires

 

The Development Requires

log logging monolog bot telegram

15/05 2018

1.2.0

1.2.0.0

Monolog handler that sends logs through Telegram bot to any chat in HTML format.

  Sources   Download

MIT

The Requires

 

The Development Requires

log logging monolog bot telegram

12/05 2018

1.1.4

1.1.4.0

Sends logs through Telegram bot to any chat in HTML format.

  Sources   Download

MIT

The Requires

 

log logging monolog telegram

31/03 2018

1.1.3

1.1.3.0

Sends logs through Telegram bot to any chat in HTML format.

  Sources   Download

MIT

The Requires

 

log logging monolog telegram

27/03 2018

1.1.2

1.1.2.0

Sends logs through Telegram bot to any chat in HTML format.

  Sources   Download

MIT

The Requires

 

log logging monolog telegram

07/03 2018

1.1.1

1.1.1.0

Sends logs through Telegram bot to any chat in HTML format.

  Sources   Download

MIT

The Requires

 

log logging monolog telegram

07/03 2018

1.1.0

1.1.0.0

Sends logs through Telegram bot to any chat in HTML format.

  Sources   Download

MIT

The Requires

 

log logging monolog telegram

22/02 2018

1.0.0

1.0.0.0

Sends your logs through Telegram bot to any chat.

  Sources   Download

MIT

The Requires

 

log logging monolog telegram