How to use the Hyperf framework for log management

How to use the Hyperf framework for log management

Introduction: Hyerpf is a high-performance, highly flexible coroutine framework based on the PHP language, with rich components and Function. Log management is an essential part of any project. This article will introduce how to use the Hyperf framework for log management and provide specific code examples.

1. Install the Hyperf framework

First, we need to install the Hyperf framework. It can be installed through Composer. Open the command line tool and enter the following command:

composer create-project hyperf/hyperf

2. Configure the log file

In the Hyperf framework, the configuration information of the log file is stored in /config/ In the autoload/logging.php file, we can set the log storage path, log level and other information in this file. The following is a simple log configuration example:

return [
    'default' => [
        'handler' => [
            'class' => MonologHandlerStreamHandler::class,
            'formatter' => env('LOG_CHAN_EN', MonologFormatterLineFormatter::class),
            'path' => BASE_PATH . '/runtime/logs/hyperf.log',
            'level' => MonologLogger::INFO,
        ],
    ],
];

Among them, the path field indicates the path where the log is stored. In this example, we store the log in the /runtime/logs/hyperf.log file.

3. Using the logging function

In the Hyperf framework, we can use the logging function through dependency injection. The following is a simple usage example:

use HyperfLoggerLoggerFactory;

class FooService
{
    /**
     * @var PsrLogLoggerInterface
     */
    private $logger;

    public function __construct(LoggerFactory $loggerFactory)
    {
        $this->logger = $loggerFactory->get('default');
    }

    public function doSomething()
    {
        // 省略业务逻辑

        $this->logger->info('Something happened');
    }
}

In the above example, we inject the LoggerFactory class into the FooService class through dependency injection. Then, we can record logs through the $this->logger->info() method.

4. Using log channels

In the Hyperf framework, logs can be divided into multiple channels, and each channel can have its own configuration and processing methods. Here is an example:

use HyperfLoggerLoggerFactory;
use MonologFormatterJsonFormatter;

class BarService
{
    /**
     * @var PsrLogLoggerInterface
     */
    private $logger;

    public function __construct(LoggerFactory $loggerFactory)
    {
        $this->logger = $loggerFactory->get('default');
    }

    public function doSomething()
    {
        // 省略业务逻辑

        $context = [
            'foo' => 'bar',
        ];

        $this->logger->channel('foo')->pushHandler(function ($record) use ($context) {
            $record['context'] = $context;
        })->info('Something happened');
    }
}

In the above example, we use $this->logger->channel('foo') to specify the log channel as 'foo'. Then, we set up a handler function through the pushHandler() method to add context information $context to the log record.

5. Use a custom log processor

In the Hyperf framework, we can use a custom log processor to process logs. The following is an example:

use HyperfLoggerLoggerFactory;
use MonologFormatterJsonFormatter;
use MonologHandlerRedisHandler;

class BazService
{
    /**
     * @var PsrLogLoggerInterface
     */
    private $logger;

    public function __construct(LoggerFactory $loggerFactory)
    {
        $this->logger = $loggerFactory->get('default');
    }

    public function doSomething()
    {
        // 省略业务逻辑

        $redisHandler = new RedisHandler(/* redis 配置 */);
        $redisHandler->setFormatter(new JsonFormatter());

        $this->logger->pushHandler($redisHandler)->info('Something happened');
    }
}

In the above example, we created a RedisHandler object and set the corresponding configuration and formatting methods. We then add the handler to the logging via the pushHandler() method.

Summary:

This article introduces how to use the Hyperf framework for log management. We achieve log management and recording by configuring log files, using the logging function, using log channels and custom log processors. Through the functions provided by the Hyperf framework, we can more conveniently manage logs and provide logging methods that meet different needs. I hope this article will be helpful to you when using the Hyperf framework for log management.

Note: The above code examples are for reference only, and the specific implementation needs to be adjusted and expanded according to project needs.

The above is the detailed content of How to use the Hyperf framework for log management. For more information, please follow other related articles on the PHP Chinese website!