inspector-apm/inspector-slim

Simple Code Execution Monitoring for Slim applications.

0.1.2 2023-01-17 20:23 UTC

Requires

• php: >=7.2
• inspector-apm/inspector-php: ^3.7
• psr/container: ^1.0
• psr/http-server-middleware: ^1.0

MIT

• Valerio Barbera

• php
• monitoring
• inspector
• slim

README

Simple code execution monitoring for Slim framework based applications.

• Requirements
• Install
• Middleware
• Test
• Add Segment
• Official Documentation
• Contribution Guidelines

Requirements

• PHP >= 7.2.0
• Slim >= 4.x

Install

Install the latest version by:

composer require inspector-apm/inspector-slim

Register On Container

First you have to register the Inspector instance inside the application container in order to make the monitoring agent available within the application.

$container->set('inspector', function () {
    $configuration = new \Inspector\Slim\Configuration('INSPECTOR_INGESTION_KEY');
    
    return new Inspector($configuration);
});

Consider to use environment variables to store your project's INGESTION KEY.

If you are using a Slim 4 skeleton you can add a new container definition in app/dependencies.php file:

use DI\ContainerBuilder;
use Psr\Container\ContainerInterface;

return function (ContainerBuilder $containerBuilder) {
    $containerBuilder->addDefinitions([
        // Other services definitions...
    
        'inspector' => function (ContainerInterface $container) {
            $configuration = new \Inspector\Slim\Configuration('INSPECTOR_INGESTION_KEY');
            return new Inspector\Inspector($configuration);
        }
        
    ]);
}

You can get an INSPECTOR_INGESTION_KEY creating a new project in your Inspector account.

Attach the Middleware

You can attach the middleware globally:

$app->add(\Inspector\Slim\WebRequestMonitoring::class);

Or in specific routes:

$app->get('/', function () {
    
    // your code here...
    
})->add(\Inspector\Slim\WebRequestMonitoring::class);

Test that everything works

Create a test route and open it in the browser http://localhost:8080:

$app->get('/test', function () {
    
    throw new \Exception('My First Exception.');
    
})->add(\Inspector\Slim\WebRequestMonitoring::class);

Add Segment

You can add segments to the transaction's timeline from route functions:

$app->get('/', function (Request $request, Response $response) {
    /*
     * Retrieve the inspector instance from the container.
     */
    $this->get('inspector')->addSegment(function () {
    
        // Your code here...
        sleep(1);
        
    }, 'sleep');
        
    return $response;
});

If your routes are organized using controllers you need to inject the container in the controller constructor:

namespace App\Controllers;


use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

class TestController
{
    protected $container;

    /**
     * Inject the container to retrieve the inspector instance later.
     */
    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }

    public function __invoke(Request $request, Response $response)
    {
        // Retrieve the inspector instance from the container.
        $this->container->get('inspector')->addSegment(function () {
        
            // Your code here...
            sleep(1);
            
        }, 'sleep');

        $response->getBody()->write('Test route.');

        return $response;
    }
}

Official documentation

Check out the official documentation

Contributing

We encourage you to contribute to Inspector! Please check out the Contribution Guidelines about how to proceed. Join us!

LICENSE

This package is licensed under the MIT license.