* * * * *
[TOC]
## 介绍
为了帮助你了解你的应用的运行状况，Laravel 提供了强大的日志记录服务，以便你将信息、系统错误记录到文件中，甚至还可以用 Slack 通知你的团队。
Laravel 的日志系统基于 [Monolog](https://github.com/Seldaek/monolog) 库，Monolog 提供了多种强力的日志处理程序。在 Laravel 中可以简单地配置这些处理程序，你可以通过混合使用配置项来自定义应用日志处理程序。
## 配置
所有日志系统相关的配置都在 `config/logging.php` 文件中。你可以在这个文件中配置应用日志记录通道，通过查看文件可以了解每个可用通道及其选项。接下来我们会查看一些常见的配置。
默认情况下 Laravel 使用 `stack` 通道记录信息。 `stack` 通道会将多个日志通道集合到单个通道中，到 [下面的文档](https://www.kancloud.cn/tonyyu/laravel_5_6/786183#_31)了解更多有关构建栈的信息。
#### 配置通道名称
Monolog 在默认情况下会以当前的环境作为「通道名称」来实例化，例如 `production` 或者 `local`。可以给你的通道配置添加一个 `name` 选项来更改这个值：
~~~
'stack' => [
'driver' => 'stack',
'name' => 'channel-name',
'channels' => ['single', 'slack'],
],
~~~
#### 配置 Slack 通道
`slack` 通道必须要有 `url` 配置项。这个 URL 要和你在 Slack 上配置的 [incoming webhook](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks) 保持一致。
### 构建日志栈
如之前所提，`stack` 驱动可以把多个通道整合到单个通道中。我们可以通过来看一个上线应用示例配置，来展示如何使用日志栈：
~~~
'channels' => [
'stack' => [
'driver' => 'stack',
'channels' => ['syslog', 'slack'],
],
'syslog' => [
'driver' => 'syslog',
'level' => 'debug',
],
'slack' => [
'driver' => 'slack',
'url' => env('LOG_SLACK_WEBHOOK_URL'),
'username' => 'Laravel Log',
'emoji' => ':boom:',
'level' => 'critical',
],
],
~~~
我们来分析一下这份配置。首先，我们注意到 `stack` 通道整合了另外两个通道，他们的 `channels` 选项分别是：`syslog` 和 `slack`。那么在记录信息时，这两个通道都会记录到该信息。
#### 日志等级
注意到 `syslog` 和 `slack` 通道都有 `level` 这个配置项。该选项用来判断可以被记录的信息的最低 「等级」。Laravel 日志服务的基础库 Monolog 提供了所有在 [RFC 5424 specification](https://tools.ietf.org/html/rfc5424) 中定义的日志等级：**emergency**、 **alert**、**critical**、 **error**、 **warning**、 **notice**、 **info** 和 **debug**。
我们想象一下用 `debug` 方法来记录一条信息：
~~~
Log::debug('An informational message.');
~~~
那么鉴于我们的配置，`syslog` 通道会将这条信息记录到系统日志上；然而在 `critical` 等级之下的错误信息并不会发送到 Slack；不过如果我们记录了一条 `emergency` 等级的信息，它将会被同时发送到 `syslog` 通道和 `slack` 通道，因为 `emergency` 等级高于这两个通道的最低日志等级：
~~~
Log::emergency('The system is down!');
~~~
## 记录日志信息
你可以用 `Log` [facade](https://www.kancloud.cn/tonyyu/laravel_5_6/786058) 记录信息到日志。就如前面提到的，日志处理程序提供了八种在 [RFC 5424 specification](https://tools.ietf.org/html/rfc5424) 里定义的日志等级：**emergency**、 **alert**、**critical**、 **error**、 **warning**、 **notice**、 **info** 和 **debug**。
~~~
Log::emergency($message);
Log::alert($message);
Log::critical($message);
Log::error($message);
Log::warning($message);
Log::notice($message);
Log::info($message);
Log::debug($message);
~~~
所以，你可以调用这些方法来记录相应等级的信息。信息会被写入 `config/logging.php` 文件中配置的默认的日志通道：
~~~
<?php
namespace App\Http\Controllers;
use App\User;
use Illuminate\Support\Facades\Log;
use App\Http\Controllers\Controller;
class UserController extends Controller
{
/**
* Show the profile for the given user.
*
* @param int $id
* @return Response
*/
public function showProfile($id)
{
Log::info('Showing user profile for user: '.$id);
return view('user.profile', ['user' => User::findOrFail($id)]);
}
}
~~~
#### 上下文信息
上下文数据也可以用数组的形式传递给日志方法。此上下文数据将被格式化并与日志消息一起显示：
~~~
Log::info('User failed to login.', ['id' => $user->id]);
~~~
### 记录日志到指定通道
有时候你可能希望将日志记录到非默认通道。你可以使用 `Log` Facade 中的 `channel` 方法，将日志记录到应用配置中存在的任何渠道：
~~~
Log::channel('slack')->info('Something happened!');
~~~
如果你想按需创建多个渠道的日志堆栈，你可以使用 `stack` 方法：
~~~
Log::stack(['single', 'slack'])->info('Something happened!');
~~~
## 自定义 Monolog 日志通道
有时你可能需要完全配置 Monolog 现有的通道。例如：你想要为现有通道自定义一个 Monolog `FormatterInterface`实现。
首先，在频道配置文件中定义一个 `tap` 数组。`tap` 数组应该包含所需的类列表，这些类就是 Monolog 实例创建后需要自定义（或开发）的类：
~~~
'single' => [
'driver' => 'single',
'tap' => [App\Logging\CustomizeFormatter::class],
'path' => storage_path('logs/laravel.log'),
'level' => 'debug',
],
~~~
当你完成了通道中 `tap` 选项的配置，你就可以开始写 Monolog 实例自定义类了。这个类只需要一个方法： `__invoke`，这个方法可以接收一个 `Illuminate\Log\Logger` 实例。 `Illuminate\Log\Logger` 实例代理了所有 Monolog 实例底层方法调用：
~~~
<?php
namespace App\Logging;
class CustomizeFormatter
{
/**
* 自定义日志实例
*
* @param \Illuminate\Log\Logger $logger
* @return void
*/
public function __invoke($logger)
{
foreach ($logger->getHandlers() as $handler) {
$handler->setFormatter(...);
}
}
}
~~~
> {提示} 所有的「tap」类可以通过 [服务容器](https://www.kancloud.cn/tonyyu/laravel_5_6/786056) 解析，所以它们所需的任何构造函数依赖项都会被自动注入。
## 创建自定义通道
如果你想定义一个完全自定义的通道以使你可以通过 Monolog 的实例和配置控制它，你可以在你的 `config/logging.php` 配置文件中定义一个 `custom` 驱动类型。此外，你的配置文件应该包含一个 `via` 选项来指定用于创建 Monolog 实例的类：
~~~
'channels' => [
'custom' => [
'driver' => 'custom',
'via' => App\Logging\CreateCustomLogger::class,
],
],
~~~
当你配置了 `custom` 通道，准备好定义创建 Monolog 实例的类。这个类只需要一个方法： `__invoke` ，它应该返回一个 Monolog 实例。
~~~
<?php
namespace App\Logging;
use Monolog\Logger;
class CreateCustomLogger
{
/**
* 创建一个 Monolog 实例。
*
* @param array $config
* @return \Monolog\Logger
*/
public function __invoke(array $config)
{
return new Logger(...);
}
}
~~~
- 前言
- 翻译说明
- 发行说明
- 升级指南
- 贡献导引
- 入门指南
- 安装
- 配置信息
- 文件夹结构
- Homestead
- Valet
- 部署
- 核心架构
- 请求周期
- 服务容器
- 服务提供者
- Facades
- Contracts
- 基础功能
- 路由
- 中间件
- CSRF 保护
- 控制器
- 请求
- 响应
- 视图
- URL
- Session
- 表单验证
- 错误
- 日志
- 前端开发
- Blade 模板
- 本地化
- 前端指南
- 编辑资源 Mix
- 安全相关
- 用户认证
- Passport OAuth 认证
- 用户授权
- 加密解密
- 哈希
- 重置密码
- 综合话题
- Artisan 命令行
- 广播系统
- 缓存系统
- 集合
- 事件系统
- 文件存储
- 辅助函数
- 邮件发送
- 消息通知
- 扩展包开发
- 队列
- 任务调度
- 数据库
- 快速入门
- 查询构造器
- 分页
- 数据库迁移
- 数据填充
- Redis
- Eloquent ORM
- 快速入门
- 模型关联
- Eloquent 集合
- 修改器
- API 资源
- 序列化
- 测试相关
- 快速入门
- HTTP 测试
- 浏览器测试 Dusk
- 数据库测试
- 测试模拟器
- 官方扩展包
- Cashier 交易工具包
- Envoy 部署工具
- Horizon
- Scout 全文搜索
- Socialite 社会化登录