PHP日志记录：Monolog库实践-php教程-PHP中文网

monolog是php中用于日志记录的强大库，其核心在于处理器和格式化器。1. 安装monolog通过composer执行“composer require monolog/monolog”。2. 基本用法包括创建日志频道、添加处理器并记录消息。3. 日志级别从低到高依次为debug、info、notice、warning、error、critical、alert、emergency，仅高于或等于设定级别的日志会被记录。4. monolog提供多种handlers，如streamhandler（写入文件）、swiftmailerhandler（发送邮件）、elasticsearchhandler（集中式日志管理）等，选择依据包括日志量、通知需求、调试需求等。5. 使用formatters可自定义日志格式，例如lineformatter（单行字符串）、jsonformatter（json格式），也可创建自定义formatter类实现格式控制。6. 在不同环境中配置monolog可通过环境变量或配置文件动态加载对应的日志设置。7. laravel内置支持monolog，可通过config/logging.php进行配置，并使用log facade记录日志，还支持通过log::extend()方法注册自定义monolog实例以满足高级需求。

PHP日志记录：Monolog库实践

Monolog是一个强大且灵活的PHP日志记录库，它允许你将日志发送到各种处理程序，例如文件、数据库、邮件等。它解决了PHP内置日志功能的不足，提供了更高级的日志管理和分析能力。

Monolog库实践

Monolog的核心在于处理器（Handlers）和格式化器（Formatters）。处理器决定了日志的去向，而格式化器决定了日志的呈现方式。通过组合不同的处理器和格式化器，你可以构建出满足各种需求的日志系统。

立即学习“PHP免费学习笔记（深入）”；

如何在PHP项目中使用Monolog？

安装Monolog:

使用Composer安装Monolog非常简单：
```
composer require monolog/monolog
```
登录后复制

基本用法:

<?php

require __DIR__ . '/vendor/autoload.php';

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// 创建一个日志频道
$log = new Logger('my_app');

// 添加一个处理器，将日志写入文件
$log->pushHandler(new StreamHandler(__DIR__ . '/app.log', Logger::WARNING));

// 添加日志消息
$log->warning('Foo');
$log->error('Bar');
?>

登录后复制

这段代码创建了一个名为 my_app 的日志频道，并将警告级别及以上的日志写入到 app.log 文件中。

理解日志级别:

Monolog定义了多个日志级别，从最不重要到最重要依次为：
- DEBUG
- INFO
- NOTICE
- WARNING
- ERROR
- CRITICAL
- ALERT
- EMERGENCY
你可以根据需要设置日志级别，只有高于或等于该级别的日志才会被记录。

Monolog的Handlers有哪些？如何选择合适的Handler？

Monolog提供了丰富的Handlers，用于将日志发送到不同的目标。一些常用的Handlers包括：

StreamHandler: 将日志写入文件或任何流。
FirePHPHandler: 将日志发送到FirePHP控制台（用于浏览器调试）。
ChromePHPHandler: 将日志发送到ChromePHP控制台。
NativeMailerHandler: 使用PHP的mail()函数发送邮件。
SwiftMailerHandler: 使用SwiftMailer库发送邮件（推荐）。
RotatingFileHandler: 每天创建一个新的日志文件，并保留一定数量的旧文件。
SyslogHandler: 将日志发送到系统日志。
ErrorLogHandler: 将日志写入PHP的错误日志。
ElasticsearchHandler: 将日志发送到 Elasticsearch 集群。
MongoDBHandler: 将日志发送到 MongoDB 数据库。
PushoverHandler: 通过 Pushover 发送通知。

选择合适的Handler取决于你的需求。例如，如果你需要将日志写入文件，可以使用StreamHandler或RotatingFileHandler。如果你需要发送邮件通知，可以使用NativeMailerHandler或SwiftMailerHandler。如果需要集中式日志管理，可以考虑 ElasticsearchHandler 或者 MongoDBHandler。

选择Handler的考虑因素：

日志量: 如果日志量很大，RotatingFileHandler可以帮助你管理日志文件。
通知需求: 如果需要实时通知，可以使用NativeMailerHandler、SwiftMailerHandler或PushoverHandler。
集中式日志管理: 如果需要集中式日志管理，可以使用ElasticsearchHandler或MongoDBHandler。
调试需求: 如果需要进行浏览器调试，可以使用FirePHPHandler或ChromePHPHandler。

如何自定义Monolog的日志格式？

Monolog允许你使用Formatters自定义日志格式。Monolog提供了一些内置的Formatters，例如：

LineFormatter: 将日志格式化为单行字符串。
HtmlFormatter: 将日志格式化为HTML。
JsonFormatter: 将日志格式化为JSON。
LogstashFormatter: 将日志格式化为Logstash格式。

你也可以创建自定义的Formatter。

使用LineFormatter自定义格式：

<?php

use Monolog\Formatter\LineFormatter;

// 创建一个LineFormatter
$formatter = new LineFormatter(
    "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n",
    "Y-m-d H:i:s",
    true,
    true
);

// 设置Formatter到Handler
$stream = new StreamHandler(__DIR__ . '/app.log', Logger::DEBUG);
$stream->setFormatter($formatter);

// 添加Handler到Logger
$log->pushHandler($stream);

$log->info('This is an info message', ['key' => 'value']);
?>

登录后复制

在这个例子中，我们创建了一个LineFormatter，并指定了日志的格式。%datetime%、%channel%、%level_name%、%message%、%context%和%extra%是占位符，Monolog会将它们替换为实际的值。 "Y-m-d H:i:s" 定义了日期时间的格式。第三个参数true 表示允许内联例外，第四个参数 true 表示忽略空上下文和额外信息。

创建自定义Formatter：

你可以继承Monolog\Formatter\FormatterInterface接口并实现format()方法来创建自定义的Formatter。

<?php

namespace App\Logging;

use Monolog\Formatter\FormatterInterface;

class MyCustomFormatter implements FormatterInterface
{
    public function format(array $record): string
    {
        return sprintf(
            '[%s] %s: %s - %s',
            $record['datetime']->format('Y-m-d H:i:s'),
            $record['level_name'],
            $record['message'],
            json_encode($record['context'])
        );
    }

    public function formatBatch(array $records): string
    {
        $message = '';
        foreach ($records as $record) {
            $message .= $this->format($record);
        }

        return $message;
    }
}

登录后复制

然后，你可以像使用内置Formatter一样使用自定义Formatter：

<?php

use App\Logging\MyCustomFormatter;

$formatter = new MyCustomFormatter();
$stream = new StreamHandler(__DIR__ . '/app.log', Logger::DEBUG);
$stream->setFormatter($formatter);
$log->pushHandler($stream);

$log->info('This is an info message', ['key' => 'value']);
?>

登录后复制

如何在不同的环境中配置Monolog？

在不同的环境中，你可能需要使用不同的日志配置。例如，在开发环境中，你可能希望将日志输出到控制台或FirePHP，而在生产环境中，你可能希望将日志写入文件或发送到集中式日志管理系统。

一种常见的做法是使用环境变量来配置Monolog。

<?php

use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\FirePHPHandler;

$log = new Logger('my_app');

$environment = getenv('APP_ENV');

if ($environment === 'development') {
    $log->pushHandler(new FirePHPHandler());
    $log->pushHandler(new StreamHandler('php://stdout', Logger::DEBUG)); // 输出到控制台
} else {
    $log->pushHandler(new StreamHandler(__DIR__ . '/app.log', Logger::WARNING));
}

$log->info('This is an info message');
?>

登录后复制

在这个例子中，我们使用getenv('APP_ENV')来获取当前环境。如果环境是development，我们将日志输出到FirePHP和控制台；否则，我们将日志写入文件。

另一种方式是使用配置文件。你可以创建一个配置文件，例如config/logging.php，并在其中定义不同的日志配置。

<?php

return [
    'development' => [
        'handlers' => [
            'firephp' => [
                'class' => Monolog\Handler\FirePHPHandler::class,
            ],
            'stream' => [
                'class' => Monolog\Handler\StreamHandler::class,
                'path' => 'php://stdout',
                'level' => Monolog\Logger::DEBUG,
            ],
        ],
    ],
    'production' => [
        'handlers' => [
            'stream' => [
                'class' => Monolog\Handler\StreamHandler::class,
                'path' => __DIR__ . '/../storage/logs/app.log',
                'level' => Monolog\Logger::WARNING,
            ],
        ],
    ],
];

登录后复制

然后，你可以根据当前环境加载相应的配置。

<?php

use Monolog\Logger;

$log = new Logger('my_app');

$environment = getenv('APP_ENV');
$config = require __DIR__ . '/config/logging.php';

$handlersConfig = $config[$environment]['handlers'] ?? $config['production']['handlers']; // 默认使用production配置

foreach ($handlersConfig as $handlerName => $handlerConfig) {
    $handlerClass = $handlerConfig['class'];
    $handler = new $handlerClass(...array_values(array_diff_key($handlerConfig, ['class' => '']))); // 传递构造函数参数
    $log->pushHandler($handler);
}

$log->info('This is an info message');
?>

登录后复制

这种方式更加灵活，你可以轻松地添加、删除或修改日志配置。

如何在Laravel中使用Monolog？

Laravel默认集成了Monolog，并提供了一个方便的配置接口。你可以在config/logging.php文件中配置Monolog。

Laravel提供了多种驱动程序（drivers），例如single、daily、slack、stack等。你可以根据需要选择合适的驱动程序。

single: 将所有日志写入单个文件。
daily: 每天创建一个新的日志文件。
slack: 将日志发送到Slack频道。
stack: 允许你组合多个驱动程序。

配置示例：

<?php

return [

    'default' => env('LOG_CHANNEL', 'stack'),

    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single', 'slack'],
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => env('LOG_LEVEL', 'debug'),
        ],

        'daily' => [
            'driver' => 'daily',
            'path' => storage_path('logs/laravel.log'),
            'level' => env('LOG_LEVEL', 'debug'),
            'days' => 14,
        ],

        'slack' => [
            'driver' => 'slack',
            'url' => env('LOG_SLACK_WEBHOOK_URL'),
            'username' => 'Laravel Log',
            'emoji' => ':boom:',
            'level' => env('LOG_LEVEL', 'critical'),
        ],

        'stderr' => [
            'driver' => 'monolog',
            'handler' => StreamHandler::class,
            'with' => [
                'stream' => 'php://stderr',
            ],
        ],

        'syslog' => [
            'driver' => 'syslog',
            'level' => env('LOG_LEVEL', 'debug'),
        ],

        'errorlog' => [
            'driver' => 'errorlog',
            'level' => env('LOG_LEVEL', 'debug'),
        ],
    ],

];

登录后复制

在这个例子中，我们配置了一个stack频道，它将日志同时写入single文件和发送到slack频道。

使用Log facade：

Laravel提供了一个方便的Log facade，你可以使用它来记录日志。

<?php

use Illuminate\Support\Facades\Log;

Log::info('This is an info message');
Log::warning('This is a warning message');
Log::error('This is an error message', ['context' => ['user_id' => 123]]);
?>

登录后复制

Laravel会自动将日志发送到配置的频道。

自定义Monolog实例：

如果你需要更高级的配置，你可以自定义Monolog实例。在AppServiceProvider的boot()方法中，你可以使用Log::extend()方法来注册自定义的频道。

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Log;
use Illuminate\Support\ServiceProvider;
use Monolog\Handler\StreamHandler;
use Monolog\Formatter\LineFormatter;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        //
    }

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        Log::extend('custom', function ($app, array $config) {
            $logger = new \Monolog\Logger('custom');
            $handler = new StreamHandler($config['path'], $config['level'] ?? 'debug');

            // 自定义Formatter
            $formatter = new LineFormatter(
                "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n",
                "Y-m-d H:i:s",
                true,
                true
            );
            $handler->setFormatter($formatter);

            $logger->pushHandler($handler);

            return $logger;
        });
    }
}

登录后复制

然后，你可以在config/logging.php文件中使用custom驱动程序。

<?php

return [

    'channels' => [
        'custom' => [
            'driver' => 'custom',
            'path' => storage_path('logs/custom.log'),
            'level' => env('LOG_LEVEL', 'debug'),
        ],
    ],

];

登录后复制

这样，你就可以完全控制Monolog的配置。

以上就是PHP日志记录：Monolog库实践的详细内容，更多请关注php中文网其它相关文章！