尝试创建自定义日志通道 Laravel 5.6

Posted 2023-02-16

【中文标题】尝试创建自定义日志通道 Laravel 5.6

【英文标题】：Trying to create custom log channel Laravel 5.6

【发布时间】：2019-01-13 21:59:58

【问题描述】：

内部config/logging.php：

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

        'mongo' => [
            'driver' => 'monolog',
            'handler' => \Monolog\Handler\MongoDBHandler::class,
            'handler_with' => [
                'mongo' => new MongoDB\Client(),
                'database' => 'logs',
                'collection' => 'test'
            ]
        ]
    ],

.env:LOG_CHANNEL=stack

我确定 MongoDB 数据库 logs 存在，test 集合也是。

我正在尝试记录php artisan tinker 中的一些数据：

Log::info('test');

我遇到了异常

预计$document 的类型为“数组或对象”，但发现为“字符串”

即使我尝试php artisan config:cache 我也遇到了这个异常。

有什么问题？

---

更新： 'mongo' => MongoDB\Client::class, 导致同样的错误。顺便说一句，文档中没有关于在 handler_with 数组中传递类或类实例的消息。

这个配置

'mongo' => [
            'driver' => 'monolog',
            'handler' => \Monolog\Handler\MongoDBHandler::class,
        ]

也返回错误，但我期望InvalidArgumentException。

这个

'mongo' => [
    'driver' => 'monolog',
    'handler' => new \Monolog\Handler\MongoDBHandler(new MongoDB\Client(),'logs', 'prod'),
]

导致LogicException : Your configuration files are not serializable.。

【问题讨论】：

你可以试试 Log::info(array('test'));

@MaheshHegde 问题不存在。

【参考方案1】：

mfn的解决方案： 将formatter 添加到通道数组中：

'formatter' => \Monolog\Formatter\MongoDBFormatter::class,

还要创建自定义格式化程序类，因为当前 Laravel 版本中使用的 mongo formatter 已过期。

<?php
/*
 * This file is part of the Monolog package.
 *
 * (c) Jordi Boggiano <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Monolog\Formatter;
/**
 * Formats a record for use with the MongoDBHandler.
 *
 * @author Florian Plattner <[e-mail]>
 */
class MongoDBFormatter implements FormatterInterface

    private $exceptionTraceAsString;
    private $maxNestingLevel;
    /**
     * @param int  $maxNestingLevel        0 means infinite nesting, the $record itself is level 1, $record['context'] is 2
     * @param bool $exceptionTraceAsString set to false to log exception traces as a sub documents instead of strings
     */
    public function __construct($maxNestingLevel = 3, $exceptionTraceAsString = true)
    
        $this->maxNestingLevel = max($maxNestingLevel, 0);
        $this->exceptionTraceAsString = (bool) $exceptionTraceAsString;
    
    /**
     * @inheritDoc
     */
    public function format(array $record)
    
        return $this->formatArray($record);
    
    /**
     * @inheritDoc
     */
    public function formatBatch(array $records)
    
        foreach ($records as $key => $record) 
            $records[$key] = $this->format($record);
        
        return $records;
    
    protected function formatArray(array $record, $nestingLevel = 0)
    
        if ($this->maxNestingLevel == 0 || $nestingLevel <= $this->maxNestingLevel) 
            foreach ($record as $name => $value) 
                if ($value instanceof \DateTime) 
                    $record[$name] = $this->formatDate($value, $nestingLevel + 1);
                 elseif ($value instanceof \Exception) 
                    $record[$name] = $this->formatException($value, $nestingLevel + 1);
                 elseif (is_array($value)) 
                    $record[$name] = $this->formatArray($value, $nestingLevel + 1);
                 elseif (is_object($value)) 
                    $record[$name] = $this->formatObject($value, $nestingLevel + 1);
                
            
         else 
            $record = '[...]';
        
        return $record;
    
    protected function formatObject($value, $nestingLevel)
    
        $objectVars = get_object_vars($value);
        $objectVars['class'] = get_class($value);
        return $this->formatArray($objectVars, $nestingLevel);
    
    protected function formatException(\Exception $exception, $nestingLevel)
    
        $formattedException = array(
            'class' => get_class($exception),
            'message' => $exception->getMessage(),
            'code' => $exception->getCode(),
            'file' => $exception->getFile() . ':' . $exception->getLine(),
        );
        if ($this->exceptionTraceAsString === true) 
            $formattedException['trace'] = $exception->getTraceAsString();
         else 
            $formattedException['trace'] = $exception->getTrace();
        
        return $this->formatArray($formattedException, $nestingLevel);
    
    protected function formatDate(\DateTime $value, $nestingLevel)
    
        return new UTCDateTime($value->getTimestamp());
    

---

更新

到目前为止我自己的实现：

config/logging.php:

'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => [... , 'mongo'],
    ],

    ...

    'mongo' => [
        'driver' => 'custom',
        'handler' => \Monolog\Handler\MongoDBHandler::class,
        'via' => \App\Logging\MongoLogger::class, //place MongoLogger where you want
        'name' => 'mongo',
        'host' => env('MONGODB_HOST'), //you can keep these right here in cofig, but I prefer .env because its scaleable
        'port' => env('MONGODB_PORT'),
        'database' => env('MONGODB_DATABASE'),
        'collection' => env('MONGODB_COLLECTION')
    ]
],

MongoLogger类：

<?php

namespace App\Logging; //once again, palce this where you want

use App\MongoDBFormatter;
use MongoDB\Client;
use Monolog\Handler\MongoDBHandler;
use Monolog\Logger;

class MongoLogger

    public function __invoke(array $config)
    
        $handler = new MongoDBHandler(
            new Client('mongodb://'.$config['host'].':'.$config['port']),
            $config['database'],
            $config['collection']
        );

        $handler->setFormatter(new MongoDBFormatter());

        return new Logger($config['name'], [$handler]);
    

MongoDBFormatter 类（稍作修改，original one with some deprecated classes, by the way）：

<?php
/*
 * This file is part of the Monolog package.
 *
 * (c) Jordi Boggiano <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace App; //once again, palce this where you want

use Monolog\Formatter\FormatterInterface;

/**
 * Formats a record for use with the MongoDBHandler.
 *
 * @author Florian Plattner <[e-mail]>
 */
class MongoDBFormatter implements FormatterInterface

    private $exceptionTraceAsString;
    private $maxNestingLevel;
    /**
     * @param int  $maxNestingLevel        0 means infinite nesting, the $record itself is level 1, $record['context'] is 2
     * @param bool $exceptionTraceAsString set to false to log exception traces as a sub documents instead of strings
     */
    public function __construct($maxNestingLevel = 3, $exceptionTraceAsString = true)
    
        $this->maxNestingLevel = max($maxNestingLevel, 0);
        $this->exceptionTraceAsString = (bool) $exceptionTraceAsString;
    
    /**
     * @inheritDoc
     */
    public function format(array $record)
    
        return $this->formatArray($record);
    
    /**
     * @inheritDoc
     */
    public function formatBatch(array $records)
    
        foreach ($records as $key => $record) 
            $records[$key] = $this->format($record);
        
        return $records;
    
    protected function formatArray(array $record, $nestingLevel = 0)
    
        if ($this->maxNestingLevel == 0 || $nestingLevel <= $this->maxNestingLevel) 
            foreach ($record as $name => $value) 
                if ($value instanceof \DateTime) 
                    $record[$name] = $this->formatDate($value, $nestingLevel + 1);
                 elseif ($value instanceof \Exception) 
                    $record[$name] = $this->formatException($value, $nestingLevel + 1);
                 elseif (is_array($value)) 
                    $record[$name] = $this->formatArray($value, $nestingLevel + 1);
                 elseif (is_object($value)) 
                    $record[$name] = $this->formatObject($value, $nestingLevel + 1);
                
            
         else 
            $record = '[...]';
        
        return $record;
    
    protected function formatObject($value, $nestingLevel)
    
        $objectVars = get_object_vars($value);
        $objectVars['class'] = get_class($value);
        return $this->formatArray($objectVars, $nestingLevel);
    
    protected function formatException(\Exception $exception, $nestingLevel)
    
        $formattedException = array(
            'class' => get_class($exception),
            'message' => $exception->getMessage(),
            'code' => $exception->getCode(),
            'file' => $exception->getFile() . ':' . $exception->getLine(),
        );
        if ($this->exceptionTraceAsString === true) 
            $formattedException['trace'] = $exception->getTraceAsString();
         else 
            $formattedException['trace'] = $exception->getTrace();
        
        return $this->formatArray($formattedException, $nestingLevel);
    
    protected function formatDate(\DateTime $value, $nestingLevel)
    
        return $value;
    

Answser source.

【参考方案2】：

嗯，显然您的“记录器”想要一组数据。我猜它可能是 JSON 格式，因此您可以在将其输入记录器之前尝试对其进行 json_decode。最好先登录到其他东西才能真正看到“推送”的数据（一个简单的 var 转储就可以了）。

另外，我还没有足够的声誉直接回复，所以请不要评论这应该是直接的“回复”；

【讨论】：

我认为，问题出在库或我的配置上。但是如果我设置正确，记录字符串可能没有问题。