# Set Up Logs | Sentry for Laravel

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](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#requirements)

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

## [Setup](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#setup)

To configure Sentry logs, you need to set the following variables in your `.env` file:

`.env`

```bash
# ...
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:

`.env`

```bash
# ...
SENTRY_ENABLE_LOGS=true
# ...
```

You can configure your log level by setting `LOG_LEVEL` or if you want a log level just for Sentry, you can use `SENTRY_LOG_LEVEL`:

`.env`

```bash
# ...
LOG_LEVEL=info # defaults to debug
SENTRY_LOG_LEVEL=warning # defaults to LOG_LEVEL
# ...
```

Also make sure your `config/sentry.php` file is up to date. You can find the latest version on [GitHub](https://github.com/getsentry/sentry-laravel/blob/master/config/sentry.php).

##### Note

If you’re using the Sentry Laravel SDK version `4.16.0` and below, or if you want to define the channel yourself to pass additional options, configure the log channel manually as described below.

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.

`config/logging.php`

```php
'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
    ],
],
```

## [Usage](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#usage)

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

```php
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.

```php
use Illuminate\Support\Facades\Log;

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

## [Options](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#options)

#### [before\_send\_log](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#before_send_log)

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

`config/sentry.php`

```php
    // ...
    '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;
    },
    // ... 
]);
```

Learn more in [Closures and Config Caching](https://docs.sentry.io/platforms/php/guides/laravel/configuration/laravel-options.md#closures-and-config-caching).

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](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#default-attributes)

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

### [Core Attributes](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#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`.
* `sdk.name`: The name of the SDK that sent the log. 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`.

### [Message Template Attributes](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#message-template-attributes)

If the log was parameterized, 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](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#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](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#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](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#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](https://docs.sentry.io/platforms/php/guides/laravel/logs.md#troubleshooting)

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

If you are testing in Tinker (`php artisan tinker`), make sure to call `\Sentry\logger()->flush();` manually to send Logs to Sentry as it does not trigger automatically.

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

`config/logging.php`

```php
    // ...
    '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:

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

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