Intallation

Search…

Intallation

Connect your Symfony application to Inspector.

Requirements
PHP >= 7.2
Symfony ^4.4 | ^5.2 | ^6.0
Install
Type the command below in your terminal to install the latest version of the bundle:
composer require inspector-apm/inspector-symfony
Configure the Ingestion Key
Create the inspector.yaml configuration file in your config/packages directory, and put the ingestion_key field inside:
inspector:
    ingestion_key: '%env(INSPECTOR_INGESTION_KEY)%'
Add the new variable in your production env file:
INSPECTOR_INGESTION_KEY=xxx
You can obtain the ingestion_key creating a new project in your Inspector dashboard.
To learn more about environment variables configuration you can check the Symfony documentation.
Test everything is working
Execute the Symfony command below to check if your app can send data to inspector correctly:
php bin/console inspector:test
Go to https://app.inspector.dev/home to explore your data.
Access the Inspector instance
Inspector instance is binded in the Symfony service container. In your controller, you can type-hint an argument with the Inspector's class name to get a concrete Inspector instance.
namespace App\Controller;
​
use Inspector\Inspector;
use Symfony\Component\HttpFoundation\Response;
​
class ProductController
{
    /**
     * @Route("/products")
     */
    public function list(Inspector $inspector): Response
    {
        $inspector->addSegment(function () {
            sleep(1);
        }, 'example-type');
​
        // ...
    }
}

Symfony

Configuration

Last modified 2mo ago

Copy link

On this page

Requirements

Install

Configure the Ingestion Key

Test everything is working

Access the Inspector instance