CodeIgniter middleware: Add performance logging and error logging to your application

CodeIgniter middleware: Add performance logs and error records to applications

Introduction:
Performance logs and error records are very critical when developing web applications. In order to effectively monitor and optimize application performance, we need to be able to obtain the execution time of the application and record error information generated in the application. CodeIgniter provides middleware functions that can easily add performance logs and error recording functions to applications. This article will introduce how to use middleware in CodeIgniter to implement performance logging and error recording functions.

1. Create middleware
First, we need to create a middleware class. In CodeIgniter, the middleware class is a class that inherits the CI_Middleware class. We can place the middleware class in the application/middleware directory (if the directory does not exist, you need to create it manually). The following is the code for an example middleware class:

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class PerformanceLoggerMiddleware extends CI_Middleware {
    public function handle(RequestInterface $request, Closure $next)
    {
        // 记录请求开始时间
        $startTime = microtime(true);

        // 执行下一个中间件或路由处理器
        $response = $next($request);

        // 计算请求执行时间
        $endTime = microtime(true);
        $executionTime = $endTime - $startTime;

        // 将执行时间记录到日志中
        log_message('info', 'Request execution time: ' . $executionTime);

        return $response;
    }
}

In the above code, we created a middleware class named PerformanceLoggerMiddleware. This middleware class inherits the CI_Middleware class and implements the handle method. The handle method receives a RequestInterface object and a Closure object as parameters. In the handle method, we first record the time when the request starts, then execute the next middleware or route processor, then calculate the time when the request is executed, and record it in the application's log.

2. Register middleware
Next, we need to register the middleware into CodeIgniter. In order to achieve this, we need to do some configuration. First, open the application/config/config.php file, find the following configuration item and set it to true:

$config['enable_hooks'] = true;

Then, open the application/config/hooks.php file and add the following in the code snippet below Code:

$hook['pre_system'][] = [
    'class' => 'PerformanceLoggerMiddleware',
    'function' => 'handle',
    'filename' => 'PerformanceLoggerMiddleware.php',
    'filepath' => 'middleware',
];

In the above code, we register the PerformanceLoggerMiddleware class as a processing function of the pre_system hook. This means that the handle method of PerformanceLoggerMiddleware will be executed before each request is processed.

3. Test the middleware
Now that we have completed the creation and registration of the middleware, we can test it. We can test this by modifying the application's main Controller. The following is an example Controller code:

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class Welcome extends CI_Controller {
    public function index()
    {
        sleep(1);  // 模拟一个耗时操作

        $this->load->view('welcome_message');
    }
}

In the above code, we simulate a time-consuming operation (using the sleep function) and then load a view file. When we access the Controller, the middleware records the execution time of the request and logs it to the application's log file.

4. View the log
Finally, we can view the performance log recorded by the middleware by opening the application's log file. In CodeIgniter, the default log files are stored in the application/logs directory. The following is the content of an example log file:

INFO - 2019-01-01 10:00:00 --> Request execution time: 1.02345204353

In the above example, we can see that the execution time of the request is recorded.

Summary:
By using middleware in CodeIgniter, we can easily add performance logging and error logging capabilities to our applications. In this article, we introduced how to create a middleware class and register it with CodeIgniter. With a simple example, we demonstrate how to use middleware to record the execution time of a request and log it to the application's log file. This approach can help us better monitor and optimize our web applications and provide a better user experience.

The above is the detailed content of CodeIgniter middleware: Add performance logging and error logging to your application. For more information, please follow other related articles on the PHP Chinese website!