dbt/laravel-mattermost-logging-driver

此包已被弃用,不再维护。未建议替代包。

Mattermost的日志驱动器

3.0.0 2020-12-09 20:01 UTC

This package is auto-updated.

Last update: 2024-04-10 03:33:50 UTC


README

此驱动器允许您将日志发送到您的Mattermost实例。它将附加异常堆栈跟踪和日志上下文/

安装

composer require dbt/laravel-mattermost-logging-driver

配置

在您的 config/logging.php 中添加新的驱动器

'mattermost' => [
    'driver' => 'custom',
    'via' => Dbt\Mattermost\Logger\Factory::class,
    'webhook' => env('MATTERMOST_WEBHOOK'),
],

如果您希望,还可以将 mattermost 通道添加到您的 stack 驱动器

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

如果您在测试期间不想将日志发送到Mattermost,请务必在本地和测试环境中设置 LOG_CHANNEL=single

选项

您可以在 config/logging.php 中的 drivervia 键之后添加其他选项。

选项 默认值 描述
webhook 您的Mattermost webhook URL。您必须设置此选项。
channel town-square 日志将被发送到的通道slug。
level Logger::INFO 低于此日志级别的消息将不会被发送。
level_mention Logger::ERROR 在此级别或更高级别的消息将ping mentions 键中的用户名
title_format '**[%s]** %s' 消息标题格式,以 sprintf() 格式的字符串表示
title_mention_format ' (ping %s)' 消息标题提及格式,以 sprintf() 格式的字符串表示
username Laravel Log 要显示的用户名
mentions ['@channel'] 要ping的用户名数组
short_field_length 62 上下文内容超过此值的将使用长字段格式化
max_attachment_length 6000 超过此长度的内容将被截断,以避免Mattermost拒绝负载。
icon_url null 要显示的相对图标URL。调用 UrlGenerator 来获取完整路径,因此您可以在多个环境中使用此选项而不必重置密钥。
scribe null 如果您想覆盖默认的消息构建器,请提供您自己的完全限定的 Scribe 接口实现
message null 如果您想覆盖默认的消息,请提供您自己的完全限定的 Message 接口实现

用法

像使用其他驱动器一样使用此驱动器。您可以通过使用 Log 门面、调用 logger 函数或从容器中获取 LogManager 来直接发送到 mattermost 通道。然后调用 channel(...)stack([...])

resolve(LogManager::class)
    ->channel('mattermost') // or ->stack(['single', 'bugsnag', 'mattermost'])
    ->info('Everyone loves a good log message.');

杂项

欢迎贡献。

MIT许可。随意使用。

基于 https://gitlab.com/thibauddauce/laravel-mattermost-logger/