README

Monitor the performance of PHP Laravel applications with Scout's PHP APM Agent. Detailed performance metrics and transaction traces are collected once the scout-apm package is installed and configured.

Requirements

PHP Version: PHP 7.2+ (PHP 8.3+ recommended)
Laravel Version: 5.5+

Quick Start

A Scout account is required. Signup for Scout.

composer require scoutapp/scout-apm-laravel

Then use Laravel's artisan vendor:publish to ensure configuration can be cached:

php artisan vendor:publish --provider="Scoutapm\Laravel\Providers\ScoutApmServiceProvider"

Configuration

In your .env file, make sure you set a few configuration variables:

SCOUT_KEY=ABC0ZABCDEFGHIJKLMNOP
SCOUT_NAME="My Laravel App"
SCOUT_MONITOR=true

Your key can be found in the Scout organization settings page.

Logging Verbosity

Once you have set up Scout and are happy everything is working, you can reduce the verbosity of the library's logging system. The library is intentionally very noisy by default, which gives us more information to support our customers if something is broken. However, if everything is working as expected, these logs can be reduced by setting the log_level configuration key to a higher Psr\Log\LogLevel. For example, if you are using .env configuration:

SCOUT_LOG_LEVEL=error

Or if you are using config/scout_apm.php:

$config[\Scoutapm\Config\ConfigKey::LOG_LEVEL] = \Psr\Log\LogLevel::ERROR;

Any of the constants defined in \Psr\Log\LogLevel are acceptable values for this configuration option.

Laravel 11 Error Handling

In Laravel 11, the App\Exceptions\Handler approach has been retired, and a new method withExceptions() has been added in bootstrap/app.php when configuring the application. In order for Scout APM Error Handling to pick up uncaught exceptions, you should add the appropriate Scout APM call, for example:

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )
    ->withMiddleware(function (Middleware $middleware) {
        // ...
    })
    ->withExceptions(function (Exceptions $exceptions) {
        // Add the following call to enable uncaught exceptions in Scout APM error reporting:
        $exceptions->reportable(function (Throwable $e) {
            app()->make(\Scoutapm\ScoutApmAgent::class)->recordThrowable($e);
        });
    })->create();

Documentation

For full installation and troubleshooting documentation, visit our help site.

Support

Please contact us at support@scoutapm.com or create an issue in this repo.

Capabilities

The Laravel library:

Registers a service \Scoutapm\ScoutApmAgent::class into the container (useful for dependency injection)
Provides a Facade \Scoutapm\Laravel\Facades\ScoutApm
Wraps view engines to monitor view rendering times
Injects several middleware for monitoring controllers and sending statistics to the Scout Core Agent
Adds a listener to the database connection to instrument SQL queries

Custom Instrumentation

In order to perform custom instrumentation, you can wrap your code in a call to the instrument method. For example, given some code to be monitored:

$request = new ServiceRequest();
$request->setApiVersion($version);

Using the provided Facade for Laravel, you can wrap the call and it will be monitored.

// At top, with other imports
use Scoutapm\Events\Span\Span;
use Scoutapm\Laravel\Facades\ScoutApm;

// Replacing the above code
$request = ScoutApm::instrument(
    'Custom',
    'Building Service Request',
    static function (Span $span) use ($version) {
        $request = new ServiceRequest();
        $request->setApiVersion($version);
        return $request;
    }
);

scoutapp / scout-apm-laravel

Maintainers

Details