README

A PHP package that defines custom Monolog handler to send Microsoft Teams notifications with an Incoming Webhook. The package aims to provide global messaging & log system that uses Microsoft Teams "MessageCard" notification and uses Monolog logging library.

功能

• 与 Microsoft Teams 频道的 Monolog 连接
• 应用程序错误通知
• 简单消息

安装

$ composer require actived/microsoft-teams-notifier

自 1.1 版本起，移除了 "symfony/monolog-bundle" 并用 "monolog/monolog" 依赖项替换，这使得 Actived Microsoft Teams Notifier 在全球范围内使用更加灵活

请考虑运行 composer suggest 命令来安装与您使用的框架相关的必需和缺失依赖项（例如，Symfony）

$ composer suggest
actived/microsoft-teams-notifier suggests:
 - symfony/monolog-bundle: The MonologBundle provides integration of the Monolog library into the Symfony framework.

Microsoft Teams Webhook 设置

按照以下步骤设置新的 Webhook

• 在 Microsoft Teams 中，选择频道名称旁边的更多选项（⋯），然后选择 '连接器'
• 在连接器列表中找到 'Incoming Webhook' 选项，并选择 '添加'
• 提供新 Webhook 所需的信息
• 复制 Webhook URL - 此信息将用于使用 ACTIVED_MS_TEAMS_DSN 配置包

Symfony 配置

将以下代码放置在 .env 文件中

###> actived/microsoft-teams-notifier ###
ACTIVED_MS_TEAMS_DSN=webhook_dsn
###< actived/microsoft-teams-notifier ###

使用以下代码将 ActivedMicrosoftTeamsHandler.php 注册为新的服务

// config\services.yaml

services:
    ...
    
    # ACTIVED MICROSOFT TEAMS NOTIFIER
+    actived_ms_teams_handler:
+        class: Actived\MicrosoftTeamsNotifier\Handler\MicrosoftTeamsHandler
+        arguments:
+            $webhookDsn: '%env(ACTIVED_MS_TEAMS_DSN)%'
+            $level: 'error'
+            $title: 'Message title' 
+            $subject: 'Message subject' 
+            $emoji:  '&#x1F6A8'  
+            $color: '#fd0404' 
+            $format: '[%%datetime%%] %%channel%%.%%level_name%%: %%message%%'

$webhookDsn
Microsoft Teams webhook url

$level
处理程序被触发并记录消息到频道的最低级别（Monolog/Logger 类：‘error’ = 400）

$title (nullable)
Microsoft Teams 消息的标题

$subject (nullable)
Microsoft Teams 消息的主题

$emoji (nullable)
Microsoft Teams 消息的 emoji（显示在消息标题旁边）。值需要反映以下模式：‘&#x<EMOJI_HEX_CODE>’

$color (nullable)
消息卡颜色主题的十六进制颜色值

$format (nullable)
每个处理程序在记录之前使用格式化程序格式化记录。此属性可以设置为覆盖默认日志消息（可用选项：%datetime% | %extra.token% | %channel% | %level_name% | %message%）。

修改您的 Monolog 设置，使其指向新的处理程序

// config\packages\dev\monolog.yaml
// config\packages\prod\monolog.yaml

monolog:
    handlers:
        ...
        
        # ACTIVED MICROSOFT TEAMS NOTIFIER
+        teams:
+            type: service
+            id: actived_ms_teams_handler

type
处理程序类型（在我们的情况下，这引用自定义通知服务）

id
notifier 服务类 \Actived\MicrosoftTeamsNotifier\LogMonolog

Laravel 配置

将以下代码放置在 .env 文件中

###> actived/microsoft-teams-notifier ###
ACTIVED_MS_TEAMS_DSN=webhook_dsn
###< actived/microsoft-teams-notifier ###

修改您的 Monolog 日志设置，使其指向新的处理程序

注意：所有参数的定义是必需的 - 请使用 NULL 值来跳过您想跳过的属性。

// config\logging.php

<?php

use Monolog\Handler\NullHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\SyslogUdpHandler;

return [
    'channels' => [
        'stack' => [
            'driver' => 'stack',
-            'channels' => ['single'],
+            'channels' => ['single', 'custom'],
            'ignore_exceptions' => false
        ],

         # ACTIVED MICROSOFT TEAMS NOTIFIER
+       'custom' => [
+            'driver' => 'custom',
+            'via' => \Actived\MicrosoftTeamsNotifier\LogMonolog::class,
+            'webhookDsn' => env('ACTIVED_MS_TEAMS_DSN'),
+            'level'  => env('LOG_LEVEL', 'debug'), // or simply 'debug'
+            'title'  => 'Message Title', // can be NULL
+            'subject'  => 'Message Subject', // can be NULL
+            'emoji'  => '&#x1F3C1', // can be NULL
+            'color'  => '#fd0404', // can be NULL
+            'format' => '[%datetime%] %channel%.%level_name%: %message%' // can be NULL
+        ],

...

driver
是每个频道的关键部分，定义了日志消息是如何以及在哪里被记录的。‘custom’ 驱动调用指定的工厂来创建一个频道。

via
将调用以创建 Monolog 实例的工厂类

webhookDsn
Microsoft Teams webhook url

level
处理程序被触发并记录消息到频道的最低级别（Monolog/Logger 类：‘debug’ = 100）

title (nullable)
Microsoft Teams 消息的标题

subject (nullable)
Microsoft Teams 消息的主题

emoji (nullable)
Microsoft Teams 消息的 emoji（显示在消息标题旁边）。值需要反映以下模式：‘&#x<EMOJI_HEX_CODE>’

color (nullable)
消息卡颜色主题的十六进制颜色值

format (nullable)
消息模板 - 可用选项：%datetime% | %extra.token% | %channel% | %level_name% | %message%

使用方法

在 Symfony/Laravel 中正确配置的服务将根据分配的级别自动在 Microsoft Teams 中生成日志。

Symfony - 手动消息

// LoggerInterface $logger
$logger->info('Info message with custom Handler');
$logger->error('Error message with custom Handler');

Laravel - 手动消息

// Illuminate\Support\Facades\Log
Log::channel('custom')->info('Info message with custom Handler');
Log::channel('custom')->error('Error message with custom Handler');

许可协议

代码可在 MIT 许可协议下使用。有关更多信息，请参阅 LICENSE 文件。