Merge pull request #6 from rsuregar/feature/add-telegram-notification

feat: Add Telegram notification support and enhance documentation with detailed setup guide
saasscaleup · Jan 5, 2025 · ceb785c · ceb785c
2 parents 03d9db2 + f63e13f
commit ceb785c
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -45,14 +45,14 @@ In today's fast-paced digital environment, timely responses to application issue
 
 ## Requirements
 
- - PHP >= 7
- - Laravel >= 5
+- PHP >= 7
+- Laravel >= 5
 
 ## ⬇️ Installation
 
 Install the package via Composer:
 
-``` bash
+```bash
 composer require saasscaleup/laravel-log-alarm
 ```
 
@@ -68,14 +68,14 @@ Saasscaleup\LogAlarm\LogAlarmServiceProvider::class,
 
 ### Publish package's config file
 
-
 Publish package's config, migration and view files by running below command:
 
 ```bash
 php artisan vendor:publish --provider="Saasscaleup\LogAlarm\LogAlarmServiceProvider"
 ```
 
 ## Usage
+
 The package will automatically start listening to your application's log events. Customize the settings in the `config/log-alarm.php` file to match your requirements.
 For Example:
 
@@ -85,11 +85,60 @@ [email protected]
 LA_NOTIFICATION_EMAIL_SUBJECT="Log Alarm Notification"
 ```
 
-In order to trigger the Log Alarm with the current defualt setting, All you need to do is 
+In order to trigger the Log Alarm with the current defualt setting, All you need to do is
 
-1. Add your `LA_SLACK_WEBHOOK_URL` and  `LA_NOTIFICATION_EMAIL` 
+1. Add your `LA_SLACK_WEBHOOK_URL` and `LA_NOTIFICATION_EMAIL`
 2. Print Error log 5 times in `tinker` or in your `Controller`
 
+## Telegram Notification Configuration
+
+Add `LA_TELEGRAM_BOT_TOKEN` and `LA_TELEGRAM_CHAT_ID` to your `.env`
+
+### Getting a Bot Token:
+
+1. Open Telegram and search for `@BotFather`
+2. Start a chat with BotFather and send `/newbot`
+3. Follow the prompts:
+
+- Provide a name for your bot
+- Provide a username for your bot (must end in 'bot'). Example: `MyTelegramBot` or `my_telegram_bot`
+
+4. BotFather will give you a bot token that looks like this: `123456789:ABCdefGHIjklMNOpqrsTUVwxyz`
+
+### Getting the Chat ID:
+
+#### Method 1 (For Direct Messages):
+
+1. Start a chat with your new bot
+2. Send it any message
+3. Visit this URL in your browser (replace with your bot token):
+
+```
+https://api.telegram.org/bot<YourBotTokenHere>/getUpdates
+```
+
+4. Look for the "chat" -> "id" field in the JSON response. It will be a number like `123456789`.
+
+```json
+"chat": {
+    "id": 123456789,
+},
+```
+
+#### Method 2 (For Groups):
+
+1. Add your bot to the group
+2. Send a message in the group
+3. Use the same /getUpdates URL method above
+4. Look for "chat" -> "id" in the response. For groups, it will be a negative number like -123456789
+
+#### Important Tips:
+
+Keep your bot token secret - anyone with it can control your bot
+For groups, make sure to give the bot permission to read messages
+If you don't see any updates in the /getUpdates response, send a new message to the bot or group
+The chat ID is permanent for that chat or group unless the bot is removed and re-added
+
 ### Tinker example:
 
 ```
@@ -117,10 +166,10 @@ The Error was occurred 5 times in the last 1 minutes:
 LOG_LEVEL: error | LOG_MESSAGE: Log alarm
 ```
 
-
 ## 🔧 Configuration
 
 Update your `.env` file with the following environment variables:
+
 ```
 LA_ENABLED=true
 LA_LOG_TYPE=error
@@ -148,7 +197,7 @@ return [
     // log time frame - log time frame to listen - in minutes
     "log_time_frame" => env('LA_LOG_TIME_FRAME', 1),
 
-    // log per time frame - How many log to count per time frame until alarm trigger 
+    // log per time frame - How many log to count per time frame until alarm trigger
     "log_per_time_frame" => env('LA_LOG_PER_TIME_FRAME', 5),
 
     // delay between alarms in minutes - How many minutes to delay between alarms
@@ -159,7 +208,7 @@ return [
 
     // notification message for log alarm
     'notification_message' => env('LA_NOTIFICATION_MESSAGE', 'Log Alarm got triggered!'),
-    
+
     // Slack webhook url for log alarm
     'slack_webhook_url' => env('LA_SLACK_WEBHOOK_URL', ''),
 
@@ -176,29 +225,25 @@ return [
 ![banner](https://github.com/saasscaleup/laravel-log-alarm/blob/master/lcl-demo.gif?raw=true)
 <br>
 
-
 ## Contribution
-We welcome contributions! Please feel free to submit a Pull Request or open an Issue on GitHub.
 
+We welcome contributions! Please feel free to submit a Pull Request or open an Issue on GitHub.
 
 ## License
+
 This package is open-sourced software licensed under the [MIT](license.md) license.
 
+## Support 🙏😃
 
+If you Like the tutorial and you want to support my channel so I will keep releasing amzing content that will turn you to a desirable Developer with Amazing Cloud skills... I will realy appricite if you:
 
-## Support 🙏😃
-
- If you Like the tutorial and you want to support my channel so I will keep releasing amzing content that will turn you to a desirable Developer with Amazing Cloud skills... I will realy appricite if you:
-
- 1. Subscribe to our [youtube](http://www.youtube.com/@ScaleUpSaaS?sub_confirmation=1)
- 2. Buy me A [coffee ❤️](https://www.buymeacoffee.com/scaleupsaas)
+1.  Subscribe to our [youtube](http://www.youtube.com/@ScaleUpSaaS?sub_confirmation=1)
+2.  Buy me A [coffee ❤️](https://www.buymeacoffee.com/scaleupsaas)
 
 Thanks for your support :)
 
 <a href="https://www.buymeacoffee.com/scaleupsaas"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=scaleupsaas&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff" /></a>
 
-
 <hr>
 
-
 Enhance your Laravel application's monitoring capabilities today with Log Alarm. Get started by installing the package and experience improved error management and faster response times.
diff --git a/src/NotificationService.php b/src/NotificationService.php
@@ -43,6 +43,15 @@ public static function send($message){
          * @return void
          */
         self::sendEmailNotification($message);
+
+        // Send Telegram notification
+        /**
+         * Send a notification to telegram.
+         *
+         * @param string $message The message to be sent.
+         * @return void
+         */
+        self::sendTelegramNotification($message);
     }
 
 
@@ -187,4 +196,51 @@ public static function sendDiscordNotification($message)
             Log::info("LogAlarm::sendDiscordNotification->error: " . $e->getMessage());
         }
     }
+
+     /**
+     * Send a notification to Telegram.
+     *
+     * This function sends a message to a Telegram chat via the Telegram Bot API.
+     *
+     * @param string $message The message to be sent.
+     * @return void
+     */
+    public static function sendTelegramNotification($message)
+    {
+        // Get the bot token and chat ID from the configuration
+        $botToken = config('log-alarm.telegram_bot_token');
+        $chatId = config('log-alarm.telegram_chat_id');
+
+        // If either the bot token or chat ID is not configured, return without sending the notification
+        if (empty($botToken) || empty($chatId)) {
+            return;
+        }
+
+        // Prepare the message text with formatting
+        $text = "*" . config('log-alarm.notification_email_subject') . "*\n\n" .
+                $message . "\n\n" .
+                "*Priority:* High";
+
+        // Prepare the data for the request
+        $data = [
+            'chat_id' => $chatId,
+            'text' => $text,
+            'parse_mode' => 'Markdown',
+            'disable_web_page_preview' => true
+        ];
+
+        // Construct the API URL
+        $apiUrl = "https://api.telegram.org/bot{$botToken}/sendMessage";
+
+        try {
+            // Send the request using HTTP facade
+            $response = Http::post($apiUrl, $data);
+
+            if (!$response->successful()) {
+                Log::info("LogAlarm::sendTelegramNotification->error: " . $response->body());
+            }
+        } catch (\Exception $e) {
+            Log::info("LogAlarm::sendTelegramNotification->error: " . $e->getMessage());
+        }
+    }
 }
diff --git a/src/config/log-alarm.php b/src/config/log-alarm.php
@@ -35,4 +35,8 @@
 
     // notification email subject for log alarm
     'notification_email_subject' => env('LA_NOTIFICATION_EMAIL_SUBJECT', 'Log Alarm Notification'),
+
+    // Telegram Bot notification
+    'telegram_bot_token' => env('LA_TELEGRAM_BOT_TOKEN', ''),
+    'telegram_chat_id' => env('LA_TELEGRAM_CHAT_ID', ''),
 ];