README

Laravel 处理器，通过 Incoming Webhook 连接器将消息发送到 Microsoft Teams。

安装

使用 composer 安装此包。

$ composer require sh-ogawa/laravel-teams-logging

集成

此包经过测试，并与 Laravel 和 Lumen 框架（5.7+）兼容。

Laravel：使用 composer 安装完成后，您需要在您的 config/app.php 文件中添加以下行

Ooga04\LaravelTeamsLogging\LoggerServiceProvider::class

Lumen：对于 Lumen，您需要在您的 bootstrap/app.php 文件中添加以下行

$app->register(Ooga04\LaravelTeamsLogging\LoggerServiceProvider::class);

Laravel：然后从 laravel-teams-logging 复制 teams 配置文件到您的配置文件夹

$ php artisan vendor:publish --provider="Ooga04\LaravelTeamsLogging\LoggerServiceProvider"

Lumen：对于 Lumen，您需要手动将文件复制到您的配置文件夹，并在 bootstrap/app.php 中启用它

$app->configure('teams');

使用 laravel logging 文件创建一个 自定义通道，或为 Lumen 创建新的日志配置文件。

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

'teams' => [
    'driver'    => 'custom',
    'via'       => \Ooga04\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'       => \Ooga04\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', [
    'Assigned to' => 'Unassigned',
    'stack trace' => $e->getTraceAsString(), // could not set getTrace(), because may be upper limit fact value's section
    'nested array' => [ // output json_encode string
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]);

在简单样式下，日志上下文将忽略消息。

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

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

结果

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

https://github.com/margatampu/laravel-teams-logging#results

许可

此 laravel-teams-logging 包可在 MIT 许可证下获得。有关更多信息，请参阅 LICENSE 文件。