Logging configuration in Laravel - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of logging in Laravel?

Logging in Laravel helps record important events and errors in your application. It acts like a diary that developers can check to understand what happened and when.

beginner

Where is the main logging configuration file located in a Laravel project?

The main logging configuration file is located at config/logging.php. This file controls how and where logs are saved.

intermediate

What does the 'stack' channel do in Laravel logging?

The 'stack' channel allows Laravel to send log messages to multiple channels at once. It's like sending a message to several friends at the same time.

intermediate

How do you change the default log level in Laravel?

You change the default log level by editing the level key in the channel configuration inside config/logging.php. Levels include debug, info, error, etc.

intermediate

What is the difference between 'single' and 'daily' log channels in Laravel?

The 'single' channel writes all logs to one file, while the 'daily' channel creates a new log file every day. This helps keep logs organized by date.

Where do you configure logging settings in a Laravel project?

A resources/views

B config/logging.php

C app/Http/Controllers

D routes/web.php

Logging settings are configured in the config/logging.php file.

Which Laravel log channel writes logs to a new file every day?

A single

B stack

C syslog

D daily

The 'daily' channel creates a new log file for each day.

What does the 'stack' log channel do?

A Sends logs to multiple channels

B Sends logs to a single file

C Sends logs to the system log

D Sends logs to the database

The 'stack' channel sends logs to multiple channels at once.

How can you set the minimum log level in Laravel?

A By editing the 'level' key in the channel config

B By changing the .env file only

C By modifying the routes file

D By updating the database

The minimum log level is set by editing the 'level' key in the channel configuration.

Which log level is the most detailed in Laravel?

A error

B info

C debug

D warning

The 'debug' level is the most detailed and logs everything.

Explain how Laravel handles logging and how you can configure different log channels.

Think about where settings live and how logs can be sent to one or many places.

Describe the difference between the 'single' and 'daily' log channels in Laravel and when you might use each.

Consider how log files grow and how you want to keep them.

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