smcrow/laravel-slack-log

利用Laravel的通知功能,在不同日志级别上向Slack提供日志记录。受Log4j启发。

1.0.2 2018-01-15 18:56 UTC

This package is not auto-updated.

Last update: 2024-09-28 06:05:52 UTC


README

Latest Stable Version Latest Unstable Version Total Downloads Build Status

此包利用Laravel创建Slack通知的原生能力,在不同日志级别上进行记录。这受Log4j启发。

日志级别

可以使用几种不同的日志级别。所需的日志级别在配置中定义。

以下是不同日志级别的示例用法

  • ERROR - 表示发生错误。
  • WARN - 表示发生错误但可恢复。
  • INFO - 通常为解释业务规则中的某些内容的信息性消息。
  • TRACE - 用于报告代码中的执行位置。可以报告进入和退出函数。
  • DEBUG - 用于输出变量的内容。

每个消息都是按相同的方式进行实现的。日志级别由您,开发者,来决定如何使用。

在发送消息之前会检查配置的日志级别。级别是包含的,即特定级别将包括其上方的所有消息级别。例如,INFO将包括INFOWARNERROR

在某些情况下,生成消息字符串可能不是一件简单的事情。已经提供了日志保护来协助完成这项工作。

安装步骤

通过Composer安装

composer require smcrow/laravel-slack-log

注册服务提供者

Laravel 5.5

Laravel 5.5允许自动发现服务提供者。《SlackLogServiceProvider》将自动被发现。

5.5版本之前的Laravel

您需要注册该命令才能使用。修改《AppServiceProvider》中的《register》方法

public function register()
{
    $this->app->register(SlackLogServiceProvider::class);
}

注册外观

您可以通过将以下内容添加到您的《app.php》别名中注册可选的外观

'SlackLog' => \Smcrow\SlackLog\Facades\SlackLog::class

配置

使用 php artisan vendor:publish 创建一个新的配置文件。文件将是《config/slack-log.php》。

在此文件中,您需要提供webhook url。我建议阅读Slack Incoming Webhooks以获取有关如何设置webhook的更多信息。

示例用法

使用日志保护和外观

$user = ['name' => 'John', 'age' => 65];

if (SlackLog::isDebugEnabled()) {
    SlackLog::debug('User: ' . print_r($user, true));
}

产生以下结果

Debug Example

反馈和贡献

请随时通过提交Issue提出建议。或者,提交带有您希望添加的任何功能的pull request。这是一个正在进行中的项目,我欢迎任何和所有的反馈。