Set Up Logs

With Sentry Structured Logs, you can send text-based log information from your Laravel applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.

Requirements

Logs for Laravel are supported in Sentry Laravel SDK version 4.15.0 and above.

Setup

To configure Sentry as a log channel, add the following config to the channels section in config/logging.php. If this file does not exist, run php artisan config:publish logging to publish it.

'channels' => [
    // ...
    'sentry_logs' => [
        'driver' => 'sentry_logs',
        // The minimum logging level at which this handler will be triggered
        // Available levels: debug, info, notice, warning, error, critical, alert, emergency
        'level' => env('LOG_LEVEL', 'info'), // defaults to `debug` if not set
    ],
],

After you configured the Sentry log channel, you can configure your app to both log to a log file and to Sentry by modifying the log stack:

# ...
LOG_CHANNEL=stack
LOG_STACK=single,sentry_logs
# ...

You will also need to configure the Sentry Laravel SDK to enable the logging integration. You can do this by updating your .env file to include the following:

# ...
SENTRY_ENABLE_LOGS=true
# ...

Also make sure your config/sentry.php file is up to date. You can find the latest version on GitHub.

Usage

Once you have configured Sentry as a log channel, you can use Laravel's built-in logging functionality to send logs to Sentry:

use Illuminate\Support\Facades\Log;

// Log to all channels in the stack (including Sentry)
Log::info('This is an info message');
Log::warning('User {id} failed to login.', ['id' => $user->id]);
Log::error('This is an error message');

// Log directly to the Sentry channel
Log::channel('sentry_logs')->error('This will only go to Sentry');

You can pass additional attributes directly to the logging functions. These properties will be sent to Sentry, and can be searched from within the Logs UI, and even added to the Logs views as a dedicated column.

use Illuminate\Support\Facades\Log;

Log::error('Something went wrong', [
    'user_id' => auth()->id(),
    'action' => 'update_profile',
    'additional_data' => $data,
]);

Options

before_send_log

To filter logs, or update them before they are sent to Sentry, you can use the before_send_log option.

    // ...
    'before_send_log' => function (\Sentry\Logs\Log $log): ?\Sentry\Logs\Log {
        if ($log->getLevel() === \Sentry\Logs\LogLevel::info()) {
            // Filter out all info logs
            return null;
        }

        return $log;
    },
    // ... 
]);

The before_send_log function receives a log object, and should return the log object if you want it to be sent to Sentry, or null if you want to discard it.

Default Attributes

The Laravel SDK automatically sets several default attributes on all log entries to provide context and improve debugging:

Core Attributes

• environment: The environment set in the SDK if defined. This is sent from the SDK as sentry.environment.
• release: The release set in the SDK if defined. This is sent from the SDK as sentry.release.
• trace.parent_span_id: The span ID of the span that was active when the log was collected (only set if there was an active span). This is sent from the SDK as sentry.trace.parent_span_id.
• sdk.name: The name of the SDK that sent the log. This is sent from the SDK as sentry.sdk.name. This is sent from the SDK as sentry.sdk.name.
• sdk.version: The version of the SDK that sent the log. This is sent from the SDK as sentry.sdk.version. This is sent from the SDK as sentry.sdk.version.

Message Template Attributes

If the log was paramaterized, Sentry adds the message template and parameters as log attributes.

• message.template: The parameterized template string. This is sent from the SDK as sentry.message.template.
• message.parameter.X: The parameters to fill the template string. X can either be the number that represent the parameter's position in the template string (sentry.message.parameter.0, sentry.message.parameter.1, etc) or the parameter's name (sentry.message.parameter.item_id, sentry.message.parameter.user_id, etc). This is sent from the SDK as sentry.message.parameter.X.

Server Attributes

• server.address: The address of the server that sent the log. Equivalent to server_name that gets attached to Sentry errors.

User Attributes

If user information is available in the current scope, the following attributes are added to the log:

• user.id: The user ID.
• user.name: The username.
• user.email: The email address.

Integration Attributes

If a log is generated by an SDK integration, the SDK will set additional attributes to help you identify the source of the log.

• origin: The origin of the log. This is sent from the SDK as sentry.origin.

Troubleshooting

If your logs are not appearing in Sentry, check or test the following:

Check your config/logging.php and ensure the default log channel and stack channel allow configuration using environment variables:

    // ...
    'default' => env('LOG_CHANNEL', 'stack'),
    // ...
    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => explode(',', (string) env('LOG_STACK', 'single')),
            'ignore_exceptions' => false,
        ],
    // ...

Ensure that if you have defined the LOG_LEVEL in your .env file, it is set to a level that allows the logs you are expecting to be sent to Sentry.

To test your setup regardless of the Laravel configuration, you can send a test log message to Sentry with the following snippet:

\Sentry\logger()->info('A test log message');
\Sentry\logger()->flush();

If that does not work, check your DSN configuration using php artisan sentry:test.