A package to integrate Elastic APM into Laravel
IMPORTANT Looking for a maintainer/owner. If you want to take over the project, please open an issue here.
Laravel package of the https://github.com/philkra/elastic-apm-php-agent library, automatically handling transactions and errors/exceptions. If using
Illuminate\Support\Facades\Auth the user Id added to the context.
Tested with Laravel
5.6.* and the philkra/elastic-apm-php-agent version
composer require philkra/elastic-apm-laravel
Register as (e.g.) global middleware to be called with every request. https://laravel.com/docs/5.6/middleware#global-middleware
Register the middleware in
protected $middleware = [ // ... more middleware \PhilKra\ElasticApmLaravel\Middleware\RecordTransaction::class, ];
PhilKra\ElasticApmLaravel\Middleware\RecordTransaction::class as middleware:
$app->middleware([ PhilKra\ElasticApmLaravel\Middleware\RecordTransaction::class ]);
No need to register service provider manually. It is registered automatically by package discovery.
\PhilKra\ElasticApmLaravel\Providers\ElasticApmServiceProvider::class as service provider:
A Transaction object is made available via the dependency container and can be used to start a new span at any point in the application. The Span will automatically add itself to the Transaction when it is ended.
// Use any normal Laravel method of resolving the dependency $transaction = app(\PhilKra\ElasticApmLaravel\Apm\Transaction::class); $span = $transaction->startNewSpan('My Span', 'app.component_name'); // do some stuff $span->end();
app/Exceptions/Handler, add the following to the
Make sure to import the facade at the top of your file:
not tested yet.
The following environment variables are supported in the default configuration:
|APM_APPNAME||Name of the app as it will appear in APM.|
|APM_APPVERSION||Version of the app as it will appear in APM.|
|APM_SERVERURL||URL to the APM intake service.|
|APM_SECRETTOKEN||Secret token, if required.|
|APM_APIVERSION||APM API version, defaults to
|APM_THRESHOLD||Query threshold in milliseconds, defaults to
You may also publish the
elastic-apm.php configuration file to change additional settings:
php artisan vendor:publish --tag=config
Once published, open the
config/elastic-apm.php file and review the various settings.
Laravel provides classes to support running unit and feature tests with PHPUnit. In most cases, you will want to explicitly disable APM during testing since it is enabled by default. Refer to the Laravel documentation for more information (https://laravel.com/docs/5.7/testing).
Because the APM agent checks it's active status using a strict boolean type, you must ensure your
APM_ACTIVE value is a boolean
false rather than simply a falsy value. The best way to accomplish this is to create an
.env.testing file and include
APM_ACTIVE=false, along with any other environment settings required for your tests. This file should be safe to include in your SCM.