Laravel development: How to use Laravel Logging to log?

Laravel is a popular PHP framework that has many built-in functions to facilitate our development, among which logging is one of them. By recording logs, we can quickly locate problems in the program and improve the stability and maintainability of the program. In this article, we will explore how to log using Laravel Logging.

1. Introduction to Laravel Logging

Laravel Logging is a logging method built into the Laravel framework. It writes logs to different storage media by specifying drivers, such as files, databases, syslog, redis, etc. In the Laravel framework, the default driver is a single file, but we can also change the default driver through simple configuration to adapt to different situations.

2. Configuring Laravel Logging

By default, the Laravel Logging configuration file is located in config/logging.php. In this file, we can define global log configuration, such as the default log driver, the storage location of log files, and the processing methods for different log levels.

By default, Laravel Logging enables the driver for a single file, which is located at storage/logs/laravel.log. In the Laravel framework, log messages can be introduced using the Log facade, for example:

use IlluminateSupportFacadesLog;
Log::info('This is an information message.');
Log::error('Something went wrong.');

Use the above code to write information and error level log messages to the default log file, and other log levels can also refer to its writing method. Record.

3. Configuring log files

In addition to the default log driver file, we can also use other drivers, such as dated files, log rotation, and HTTP requests Send logs to remote services and more. In the config/logging.php file, we can directly define the log driver and parameters, for example:

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

'syslog' => [
    'driver' => 'syslog',
    'level' => 'warning',
]

We can use the daily driver to split the log file according to date, and the period of each file is 14 sky. We can also use the syslog driver to send log messages to the system's logging service, such as the Linux syslogd daemon.

4. Record context information

In practical applications, we often need to record some context information at the same time, such as user ID, requested URI, client IP address, etc. In Laravel Logging, we can record this information through the log context.

For example, in an HTTP request, we can use the following code to record some contextual information to the log file:

use IlluminateSupportFacadesLog;
Log::channel('mylog')->withContext([
    'user_id' => $request->user()->id,
    'ip' => $request->getClientIp(),
    'uri' => $request->getUri(),
])->info('An information message with context.');

In the above code, we use the channel method of the Log facade, A log channel named mylog is specified. Then use the withContext method to pass some context information into the logger, and finally use the info method to log the log message to a file.

5. Custom Laravel Logging

In addition to using the default configuration of Laravel Logging, we can also implement more complex logging by writing a custom logger component system.

First, we need to create a new log channel configuration, for example:

'custom' => [
    'driver' => 'custom',
    'via' => AppLoggingCustomLogger::class,
    'level' => 'debug',
],

In the above configuration, we specify a custom driver and instantiate one using AppLoggingCustomLogger::class Custom log writer.

We can then write a custom log writer component, for example:

<?php

namespace AppLogging;

use MonologFormatterHtmlFormatter;
use MonologHandlerStreamHandler;
use MonologLogger;

class CustomLogger
{
    static public function __invoke(array $config)
    {
        $logger = new Logger('custom');

        $handler = new StreamHandler($config['path']);
        $handler->setFormatter(new HtmlFormatter());

        $logger->pushHandler($handler);

        return $logger;
    }
}

In the above example, we created a class called CustomLogger that uses Monolog Some functions in the component write logs to specified files and record them in HTML format.

Finally, we can use a custom logger in the following ways:

use IlluminateSupportFacadesLog;
Log::channel('custom')->info('A custom information message.');

In this way, we can fully control the implementation of Laravel Logging and achieve more customized logs Document requirements.

Summary

Laravel Logging is a logging method built into the Laravel framework. It can record log messages to various storage media such as files, databases, and syslog. We can control the recording method and the content of log messages through configuration files and context recording. In addition, we can also flexibly customize the implementation of Laravel Logging by writing custom logger components. Logging through Laravel Logging helps the stability and maintainability of the program and is a very important part of Laravel development.

The above is the detailed content of Laravel development: How to use Laravel Logging to log?. For more information, please follow other related articles on the PHP Chinese website!