README

Brings up the option for sending the logs to Google Chat from Laravel.

Derived from a fork of theriddleofenigma but with some more QA and some additional features and fixes.

Usage

Installation

composer require rikvdh/laravel-google-chat-log

Configuration

Add the following code to the channels array in config/logging.php in your laravel/lumen application.

'google-chat' => [
    'driver' => 'monolog',
    'handler' => \Enigma\GoogleChatHandler::class,
    'with' => [
        'url' => env('LOG_GOOGLE_CHAT_WEBHOOK_URL'),
        'notify_users' => [
            'default' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_DEFAULT'),
            'emergency' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_EMERGENCY'),
            'alert' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_ALERT'),
            'critical' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_CRITICAL'),
            'error' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_ERROR'),
            'warning' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_WARNING'),
            'notice' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_NOTICE'),
            'info' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_INFO'),
            'debug' => env('LOG_GOOGLE_CHAT_NOTIFY_USER_ID_DEBUG'),
        ],
    ],
    'level' => env('LOG_LEVEL', 'debug'),
],

You can provide the eight logging levels defined in the RFC 5424 specification: emergency, alert, critical, error, warning, notice, info, and debug

Note*: Make sure to set the LOG_GOOGLE_CHAT_WEBHOOK_URL env variable. Multiple comma-separated urls are supported.

The optional LOG_GOOGLE_CHAT_NOTIFY_USER_ID_* variables can be used to notify specific users via @mention. User Ids mapped under LOG_GOOGLE_CHAT_NOTIFY_USER_ID_DEFAULT will be notified for all log levels. To get a USER_ID, right-click the user-icon of the person whom you want to notify in the Google chat from your browser window and select inspect. Under the div element find the attribute data_member_id, then the USER_ID can be found as data-member-id="user/human/{USER_ID}>". In order to notify all the users like @all, Set LOG_GOOGLE_CHAT_NOTIFY_USER_ID_DEFAULT=all. Also, you can set multiple USER_IDs as comma separated value. In order to notify different users for different log levels, you can set the corresponding env keys mentioned to configure in the logging.php file.

Additional log context

Now, you can add custom additional logs to the Google chat message by passing a closure function to the GoogleChatHandler::$additionalLogs property. The request object will be passed as first argument to the closure while calling.

use Enigma\GoogleChatHandler;
use Illuminate\Http\Request;

class AppServiceProvider {
    public function register() {}
    public function boot() {
        GoogleChatHandler::$additionalLogs = function (Request $request) {
            return [
                'tenant' => $request->user()?->tenant->name,
                'request' => json_encode($request->toArray()),
            ];
        };
    }
}

Lumen compatibility

Note*: For lumen, make sure the $app->withFacades(); is uncommented in the bootstrap/app.php.

License

Laravel Google Chat Log is open-sourced software licensed under the MIT license.

rikvdh / laravel-google-chat-log

Maintainers

Package info

Statistics

Security