Logging configuration in Laravel

Introduction

Logging helps you keep track of what your Laravel app is doing. It records errors and important events so you can fix problems and understand app behavior.

When you want to record errors to find and fix bugs.

When you need to track user actions for security or auditing.

When you want to monitor app performance or unusual activity.

When debugging issues in development or production environments.

When you want to save logs to different places like files, databases, or external services.

Syntax

Laravel

config/logging.php

This file controls how Laravel logs messages.

You can set log channels, formats, and storage locations here.

Examples

Sets the default log channel. 'stack' means it uses multiple channels together.

Laravel

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

Defines a single file log channel that writes all logs to one file.

Laravel

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

Defines a daily log channel that creates a new log file each day and keeps logs for 14 days.

Laravel

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

Sample Program

This config sets the default log to 'stack' which sends logs to both a single file and Slack for critical errors.

Laravel

<?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' => 'debug',
        ],

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

Important Notes

Use the .env file to set LOG_CHANNEL and LOG_SLACK_WEBHOOK_URL for easy changes without editing code.

Log levels include debug, info, notice, warning, error, critical, alert, emergency.

Stack channels let you send logs to multiple places at once.

Summary

Logging configuration controls where and how Laravel saves logs.

You can log to files, Slack, databases, and more using channels.

Use the default channel to set the main logging method for your app.

Practice

1. What is the main purpose of Laravel's logging configuration?

easy

A. To configure user authentication methods

B. To control where logs are saved and what details are recorded

C. To manage database connections

D. To set up email notifications

Solution

1. Step 1: Understand logging configuration role

   Logging configuration in Laravel defines how and where logs are stored and what level of detail is recorded.

2. Step 2: Compare with other options

   Database connections, authentication, and email notifications are unrelated to logging configuration.

3. Final Answer:

   To control where logs are saved and what details are recorded -> Option B

4. Quick Check:

   Logging config = control log storage and detail [OK]

Hint: Logging config sets log storage and detail level [OK]

Common Mistakes:

• Confusing logging with database setup
• Mixing logging with authentication settings
• Thinking logging controls email features

2. Which of the following is the correct way to define a single log channel in Laravel's config/logging.php?

easy

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

B. 'single' => ['driver' => 'file', 'path' => 'storage/logs/laravel.log', 'level' => 'info']

C. 'single' => ['driver' => 'stack', 'channels' => ['daily'], 'level' => 'error']

D. 'single' => ['driver' => 'daily', 'path' => storage_path('logs/laravel.log'), 'days' => 7]

Solution

1. Step 1: Identify correct driver and keys for single channel

   The 'single' channel uses 'driver' => 'single', a 'path' with storage_path helper, and a 'level' key.

2. Step 2: Check options for syntax and correctness

   'single' => ['driver' => 'single', 'path' => storage_path('logs/laravel.log'), 'level' => 'debug'] matches correct syntax. 'single' => ['driver' => 'file', 'path' => 'storage/logs/laravel.log', 'level' => 'info'] uses wrong driver 'file'. 'single' => ['driver' => 'stack', 'channels' => ['daily'], 'level' => 'error'] uses 'stack' driver incorrectly. 'single' => ['driver' => 'daily', 'path' => storage_path('logs/laravel.log'), 'days' => 7] misses 'level' key and has wrong driver.

3. Final Answer:

   'single' => ['driver' => 'single', 'path' => storage_path('logs/laravel.log'), 'level' => 'debug'] -> Option A

4. Quick Check:

   Single channel = driver 'single' + path + level [OK]

Hint: Single channel uses driver 'single' with path and level keys [OK]

Common Mistakes:

• Using 'file' instead of 'single' as driver
• Confusing 'stack' driver with 'single'
• Omitting required keys like 'level'

3. Given this logging configuration snippet in config/logging.php:

'stack' => [
    'driver' => 'stack',
    'channels' => ['single', 'slack'],
    'ignore_exceptions' => false,
],
'single' => [
    'driver' => 'single',
    'path' => storage_path('logs/laravel.log'),
    'level' => 'debug',
],
'slack' => [
    'driver' => 'slack',
    'url' => env('LOG_SLACK_WEBHOOK_URL'),
    'level' => 'critical',
    'username' => 'Laravel Log',
],

What happens when you log an error with level 'error' using the 'stack' channel?

medium

A. The message is ignored because 'ignore_exceptions' is false

B. The message is sent to Slack but not saved to the log file

C. The message is saved to the single log file but not sent to Slack

D. The message is saved to the log file and sent to Slack

Solution

1. Step 1: Understand channel levels and stack behavior

   The 'stack' channel sends logs to both 'single' and 'slack' channels. 'single' logs at 'debug' level, 'slack' at 'critical'.

2. Step 2: Compare log level 'error' with channel levels

   'error' is lower than 'critical', so Slack ignores it. 'single' accepts 'error' since 'debug' is lower level threshold.

3. Final Answer:

   The message is saved to the single log file but not sent to Slack -> Option C

4. Quick Check:

   Stack sends to channels; level filters Slack but not single [OK]

Hint: Stack sends to all channels; level filters each channel separately [OK]

Common Mistakes:

• Assuming all channels receive every log regardless of level
• Confusing 'ignore_exceptions' with log filtering
• Thinking Slack receives 'error' level logs when set to 'critical'

4. You have this incorrect logging channel configuration in config/logging.php:

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

What is the error and how do you fix it?

medium

A. The 'days' value should be an integer, not a string; change '7' to 7

B. The 'path' should not use storage_path helper; use a string path instead

C. The 'level' key is invalid for daily driver and should be removed

D. The 'driver' should be 'single' instead of 'daily'

Solution

1. Step 1: Identify type error in 'days' key

   The 'days' key expects an integer number of days to keep logs, but it is given as a string '7'.

2. Step 2: Correct the data type

   Change 'days' => '7' to 'days' => 7 to fix the type mismatch.

3. Final Answer:

   The 'days' value should be an integer, not a string; change '7' to 7 -> Option A

4. Quick Check:

   'days' must be integer, not string [OK]

Hint: Numeric config values must be integers, not quoted strings [OK]

Common Mistakes:

• Leaving numeric values as strings causes config errors
• Removing valid keys like 'level' mistakenly
• Changing driver unnecessarily

5. You want to create a custom logging channel in Laravel that writes logs to a daily rotating file and also sends critical errors to Slack. Which configuration correctly combines these requirements?

hard

A. 'custom' => ['driver' => 'stack', 'channels' => ['single'], 'ignore_exceptions' => true], 'single' => ['driver' => 'single', 'path' => storage_path('logs/custom.log'), 'level' => 'debug']

B. 'custom' => ['driver' => 'daily', 'path' => storage_path('logs/custom.log'), 'level' => 'critical', 'days' => 14], 'slack' => ['driver' => 'stack', 'channels' => ['daily'], 'url' => env('LOG_SLACK_WEBHOOK_URL')],

C. 'custom' => ['driver' => 'slack', 'url' => env('LOG_SLACK_WEBHOOK_URL'), 'level' => 'debug'], 'daily' => ['driver' => 'daily', 'path' => storage_path('logs/custom.log'), 'level' => 'critical', 'days' => 7],

D. 'custom' => ['driver' => 'stack', 'channels' => ['daily', 'slack'], 'ignore_exceptions' => false], 'daily' => ['driver' => 'daily', 'path' => storage_path('logs/custom.log'), 'level' => 'debug', 'days' => 14], 'slack' => ['driver' => 'slack', 'url' => env('LOG_SLACK_WEBHOOK_URL'), 'level' => 'critical', 'username' => 'Custom Logger']

Solution

1. Step 1: Understand requirements for combined logging

   You need a stack channel combining 'daily' file logging and 'slack' for critical errors.

2. Step 2: Check each option for correct driver and channel setup

   'custom' => ['driver' => 'stack', 'channels' => ['daily', 'slack'], 'ignore_exceptions' => false], 'daily' => ['driver' => 'daily', 'path' => storage_path('logs/custom.log'), 'level' => 'debug', 'days' => 14], 'slack' => ['driver' => 'slack', 'url' => env('LOG_SLACK_WEBHOOK_URL'), 'level' => 'critical', 'username' => 'Custom Logger'] correctly defines 'custom' as a stack channel with 'daily' and 'slack' channels. 'daily' logs debug and above, 'slack' logs critical only. Other options misuse drivers or channels.

3. Final Answer:

   'custom' => ['driver' => 'stack', 'channels' => ['daily', 'slack'], 'ignore_exceptions' => false], 'daily' => ['driver' => 'daily', 'path' => storage_path('logs/custom.log'), 'level' => 'debug', 'days' => 14], 'slack' => ['driver' => 'slack', 'url' => env('LOG_SLACK_WEBHOOK_URL'), 'level' => 'critical', 'username' => 'Custom Logger'] -> Option D

4. Quick Check:

   Stack channel combines daily + slack with correct levels [OK]

Hint: Use stack driver to combine daily file and Slack channels [OK]

Common Mistakes:

• Using wrong driver for stack channel
• Misplacing Slack inside daily channel
• Setting ignore_exceptions true when not needed