senthilhep/hep-laravel-teams-logging

Laravel 处理器,用于通过 Incoming Webhook 连接器向 Microsoft Teams 发送消息

dev-main 2024-01-04 10:13 UTC

This package is auto-updated.

Last update: 2024-09-04 11:45:10 UTC


README

Software License

Laravel 处理器,通过 Incoming Webhook 连接器向 Microsoft Teams 发送消息。

安装

使用 composer 安装此包。

$ composer require senthilhep/hep-laravel-teams-logging

集成

该包经过测试,与 Laravel 和 Lumen 框架(10+)兼容。

Laravel:使用 composer 安装完成后,您需要将以下行添加到您的 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 日志文件创建一个 自定义通道,或者为 Lumen 创建新的日志配置文件。

将此配置添加到 config/logging.php 文件中

'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'
],

或简单地添加名称以指定每个连接器的不同项目名称。

'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'
],

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 通道的通知的一些结果。

  • Microsoft Teams 通道中的调试日志预览 截图

  • Microsoft Teams 通道中的信息日志预览 截图

  • Microsoft Teams 通道中的通知日志预览 截图

  • Microsoft Teams 通道中的警告日志预览 截图

  • Microsoft Teams 通道中的错误日志预览 截图

  • Microsoft Teams频道中的关键日志预览 截图

  • Microsoft Teams频道中的警报日志预览 截图

  • Microsoft Teams频道中的紧急日志预览 截图

许可协议

此laravel-teams-logging软件包采用MIT许可协议。更多信息请参阅LICENSE文件。