majidse/laravel-teams-logging

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

dev-master 2023-03-15 16:57 UTC

This package is not auto-updated.

Last update: 2024-09-26 22:16:31 UTC


README

Latest Version on Packagist Software License Total Downloads

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

安装

使用Composer安装此包。

$ composer require margatampu/laravel-teams-logging

集成

此包已在Laravel和Lumen框架(5.7+)上进行测试并工作。

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消息有2种可用样式,简单和卡片。您可以在结果样式中看到卡片样式,它与简单样式不同。

将配置添加到您的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'  => 'Assigned to',
        'value' => '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文件。