easyweb/laravel-teams-logging

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

v1.2.4 2023-07-27 05:42 UTC

This package is not auto-updated.

Last update: 2024-09-24 17:22:24 UTC


README

Software License

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日志文件创建一个自定义通道,或为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'  => 'value',
    'Assigned to' => 'Unassigned'
]);

在使用简单样式时,日志上下文将被忽略。

您还可以将teams添加到默认的stack通道,以便所有错误都自动发送到teams通道。

'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => ['single', 'teams'],
    ],
],

结果

以下是使用卡片样式发送到Microsoft Teams通道的通知的一些结果。

  • 在Microsoft Teams通道中的调试日志预览 Screenshot

  • 在Microsoft Teams通道中的信息日志预览 Screenshot

  • 在Microsoft Teams通道中的注意日志预览 Screenshot

  • 在Microsoft Teams通道中的警告日志预览 Screenshot

  • 在Microsoft Teams通道中的错误日志预览 Screenshot

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

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

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

许可证

此laravel-teams-logging包采用MIT许可证。有关更多信息,请参阅LICENSE文件。