margatampu / laravel-teams-logging
Laravel 处理器,通过 Incoming Webhook 连接器将消息发送到 Microsoft Teams
Requires
- php: ^8.1
- monolog/monolog: ^3.0
Requires (Dev)
- ext-curl: *
README
Laravel 处理器,通过 Incoming Webhook 连接器将消息发送到 Microsoft Teams。
安装
使用 composer 安装此包。
$ composer require margatampu/laravel-teams-logging
集成
该包已在 Laravel 和 Lumen 框架(10+)中测试并正常工作。
Laravel:安装完成后,您需要将以下行添加到您的 config/app.php
MargaTampu\LaravelTeamsLogging\LoggerServiceProvider::class
Lumen:对于 Lumen,您需要将以下行添加到您的 bootstrap/app.php
$app->register(MargaTampu\LaravelTeamsLogging\LoggerServiceProvider::class);
Laravel:然后从 laravel-teams-logging 复制 teams
配置文件到您的配置文件夹
$ php artisan vendor:publish --provider="MargaTampu\LaravelTeamsLogging\LoggerServiceProvider"
Lumen:对于 Lumen,您需要手动将文件复制到您的配置文件夹,并在 bootstrap/app.php
中启用它
$app->configure('teams');
使用 laravel logging 文件创建一个自定义通道或为 Lumen 创建新的日志配置文件。
将此配置添加到 config/logging.php
文件中
'teams' => [ 'driver' => 'custom', 'via' => \MargaTampu\LaravelTeamsLogging\LoggerChannel::class, 'level' => 'debug', 'url' => env('INCOMING_WEBHOOK_URL'), 'style' => 'simple', // Available style is 'simple' and 'card', default is 'simple' ],
或简单地添加名称以指定每个连接器的不同项目名称。
'teams' => [ 'driver' => 'custom', 'via' => \MargaTampu\LaravelTeamsLogging\LoggerChannel::class, 'level' => 'debug', 'url' => env('INCOMING_WEBHOOK_URL'), 'style' => 'simple', // Available style is 'simple' and 'card', default is 'simple' 'name' => 'Dummy Project' ],
Microsoft Teams 消息有两种可用样式:简单和卡片。您可以在结果样式中看到卡片样式,它与简单样式不同。
将配置添加到您的 config/logging.php
文件后,请将 INCOMING_WEBHOOK_URL
变量添加到您的 .env
文件中,并使用 Microsoft Teams 连接器的连接器 URL。请阅读 microsoft teams 文档以查找您的连接器 URL。
用法
要向 Teams 通道发送简单的错误消息,请使用以下脚本
Log::channel('teams')->error('Error message');
或者,您可以使用日志上下文向卡片消息添加更多信息。
Log::channel('teams')->error('Error message', [ 'name' => 'value', 'Assigned to' => 'Unassigned' ]);
在简单样式中,日志上下文将被忽略。
您还可以将 teams
添加到默认的 stack
通道,以便所有错误都自动发送到 teams
通道。
'channels' => [ 'stack' => [ 'driver' => 'stack', 'channels' => ['single', 'teams'], ], ],
结果
以下是使用卡片样式发送到 Microsoft Teams 通道的通知的一些结果。
许可证
此laravel-teams-logging软件包受MIT许可证的约束。有关更多信息,请参阅LICENSE文件。