Laravel Octane

The package tideways/laravel-octane-middleware connects a Laravel Octance application with Tideways for PHP Monitoring, Profiling and Exception Tracking.

Octane is an alternative PHP runtime that uses the Roadrunner or Swoole projects to process multiple web requests with the same PHP process, avoiding the bootstrapping overhead of the framework. This allows extremely fast responses starting from 1 or 2 ms:

Tideways Trace recorded from Octane powered application

The integration package provides a Laravel HTTP middleware that starts Tideways based on the Laravel Request object state.

Laravel Octane support works best with a Tideways PHP extension from 5.3.16 and up.

Installation

You can install the package via composer:

composer require tideways/laravel-octane-middleware

Usage

Register the Middleware in your Laravel Middleware stack:

<?php

class Kernel extends HttpKernel
{
    protected $middleware = [
        \Tideways\LaravelOctane\OctaneMiddleware::class,
        // ...
    ];

    // ...
}

Install Tideways PHP extension for PHP 8 and configure the API Key via php.ini or additional configuration files tideways.ini:

tideways.api_key=abcdefg

See more details on how to install and get the API Key in the Tideways docs

Known Issues

  • Triggering traces via Chrome Extension requires Tideways PHP Extension version 5.3.16 and up

  • Laravel framework spans and events in Profiler require Tideways PHP Extension version 5.3.16 and up

License

The MIT License (MIT). Please see License File for more information.

Still need help? Email [email protected]