https://github.com/electrobayan/telegram-logger
This extension allows you to see your project logs in real time using Telegram app.
https://github.com/electrobayan/telegram-logger
logger logging telegram telegram-logger
Last synced: 11 months ago
JSON representation
This extension allows you to see your project logs in real time using Telegram app.
- Host: GitHub
- URL: https://github.com/electrobayan/telegram-logger
- Owner: electrobayan
- Created: 2021-05-10T09:39:10.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-12-23T11:27:50.000Z (over 4 years ago)
- Last Synced: 2024-09-24T20:06:36.278Z (over 1 year ago)
- Topics: logger, logging, telegram, telegram-logger
- Language: PHP
- Homepage: https://www.linkedin.com/in/mstislav-sergeev-a2852714a/
- Size: 33.2 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Telegram Logger
[](https://packagist.org/packages/electrobayan/telegram-logger)
This extension allows you to see your project logs in real time using Telegram app.
## How To Install
via Composer require command (composer 2 is required):
Just type into the CLI in your project root:
composer require electrobayan/telegram-logger
via updating composer.json:
{
"require": {
"electrobayan/telegram-logger": "^1.0"
}
}
Then run in you CLI:
composer install
## How To Use
### Quick example:
You will have to create a Telegram bot and a channel. Check the user guide here.
Then just do the following:
$infoLogger = new \TelegramLogger\Creator\InfoPoster('Telegram Key Goes here', '@your_telegram_channel_name');
$infoLogger->post('test', ['key_1' => 'value_1', 'key_2' => 'value_2'], ['tag1', 'tag2']);
### Details
There 3 types of log messages:
- Info
- Warning
- Error
You are free to create new if needed.
Each of these types of messages has their own icons, frame and titles. Depending on what type you need you should use an appropriate Poster: `InfoPoster`, `ErrorPoster` or `WarningPoster`.
$errorLogger = new \TelegramLogger\Creator\ErrorPoster('Telegram Key Goes here', '@your_telegram_channel_name');
$warningLogger = new \TelegramLogger\Creator\WarningPoster('Telegram Key Goes here', '@your_telegram_channel_name');
$infoLogger = new \TelegramLogger\Creator\InfoPoster('Telegram Key Goes here', '@your_telegram_channel_name');
After the poster created all is left is just to call `post` method.
$errorLogger->post('Error Message', ['key_1' => 'value_1', 'key_2' => 'value_2'], ['tag1', 'tag2']);
$warningLogger->post('Warning Message', ['key_1' => 'value_1', 'key_2' => 'value_2'], ['tag1', 'tag2']);
$infoLogger->post('Info Message', ['key_1' => 'value_1', 'key_2' => 'value_2'], ['tag1', 'tag2']);
Also, you can pass optional extra params if needed as an array `key => value`. Both key and value will be posted into the channel.
You can pass optional tags if needed as an array `key => value`. Only values will be posted into the channel.