senthilhep / hep-laravel-teams-logging
Laravel handler to sending messages to Microsoft Teams using the Incoming Webhook connector
Installs: 1 743
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: >=7.0
- monolog/monolog: ^1.23|^2.0|^3.0
Requires (Dev)
- ext-curl: *
This package is auto-updated.
Last update: 2024-11-04 12:13:23 UTC
README
Laravel handler to sending messages to Microsoft Teams using the Incoming Webhook connector.
Installation
Require this package with composer.
$ composer require senthilhep/hep-laravel-teams-logging
Integration
Package tested and worked with Laravel and Lumen framework (10+).
Laravel: After installation using composer finishes up, you'll have to add the following line to your config/app.php
:
MargaTampu\LaravelTeamsLogging\LoggerServiceProvider::class
Lumen: For Lumen, you'll have to add the following line to your bootstrap/app.php
:
$app->register(MargaTampu\LaravelTeamsLogging\LoggerServiceProvider::class);
Laravel: Then copy teams
config file from laravel-teams-logging to your config folder:
$ php artisan vendor:publish --provider="MargaTampu\LaravelTeamsLogging\LoggerServiceProvider"
Lumen: For Lumen, you need to copy file manually to your config folder and enable it in bootstrap/app.php
:
$app->configure('teams');
Create a custom channel using laravel logging file or create new logging config file for lumen.
Add this configuration to config/logging.php
file
'teams' => [ 'driver' => 'custom', 'via' => \MargaTampu\LaravelTeamsLogging\LoggerChannel::class, 'level' => 'debug', 'url' => env('TEAMS_INCOMING_WEBHOOK_URL'), 'style' => 'simple', // Available style is 'simple' and 'card', default is 'simple' ],
or simply add name to specify different project name for each connector.
'teams' => [ 'driver' => 'custom', 'via' => \MargaTampu\LaravelTeamsLogging\LoggerChannel::class, 'level' => 'debug', 'url' => env('TEAMS_INCOMING_WEBHOOK_URL'), 'style' => 'simple', // Available style is 'simple' and 'card', default is 'simple' 'name' => 'Dummy Project' ],
There are 2 available styles for microsoft teams message, using simple and card. You can see card style in results style which is difference from simple style.
After added configs to your config/logging.php
file, add INCOMING_WEBHOOK_URL
variable to your .env
file with connector url from your microsoft teams connector. Please read microsoft teams document to find your connector url.
Usage
To send a simple error message to teams channel, you kindly use script below:
Log::channel('teams')->error('Error message');
Or you can include additional info to card message using log context.
Log::channel('teams')->error('Error message', [ 'name' => 'value', 'Assigned to' => 'Unassigned' ]);
When using simple style, log context will ignore from message.
You can also add teams
to the default stack
channel so all errors are automatically send to the teams
channel.
'channels' => [ 'stack' => [ 'driver' => 'stack', 'channels' => ['single', 'teams'], ], ],
Results
Here are some results of notifications sent to microsoft teams channel using card style.
License
This laravel-teams-logging package is available under the MIT license. See the LICENSE file for more info.