DEV Community

loading...
Cover image for Laravel Real-Time performance monitoring & alerting using Inspector
Inspector

Laravel Real-Time performance monitoring & alerting using Inspector

Valerio
I'm a Software Engineer CTO at Inspector.dev
Originally published at inspector.dev Updated on ・5 min read

Hi, I’m Valerio Barbera software engineer and Laravel — certified developer from Naples, Italy.

I’m the creator of Inspector, the Real-Time monitoring dashboard for Laravel applications.

As product owner I learned on my skin how an application issue isn't just a technical stuff. For software-driven companies errors could create a negative impact on the users experience and on their perception about our products and work.

Users don't spend their time to report bugs, they just stop using our application, checking for another one that fits their needs better.

I'm one of those that publish new code changes almost every day and unfortunately it's quite impossible to anticipate all the problems that could happen after every update.

In most of the projects I've worked on the 50% of the drawbacks for users were caused by simple code mistakes, often in the code executed in background (artisan commands or Jobs) where it’s even more tricky to know if all is working fine or something is broken.

Inspector is a composer package to add real-time monitoring in Laravel applications, it’s very easy to install and use, and it takes just two minutes to get started.

Thanks to Inspector I no longer need to spend a lot of time to search errors inside logs or a strange terminal command, because an autonomous tool is doing this job for me, making it rise to the surface anything that could create problems for users immediately.

It’s very easy to install and use, and it takes just two minutes to get started.

Let me show you how it works.

Install the composer package

Run the composer command in your terminal:

composer require inspector-apm/inspector-laravel

Configure the API key

Get a fresh API key by signing up for Inspector and creating a new project, it takes 30 seconds.

You’ll see installation instructions directly in the app screen:

Put the API key into your environment file:

INSPECTOR_API_KEY=9a304b04b8XXXXXXXXXXXX1f

Test everything is working

Execute our test command to check if your app send data to inspector correctly:

php artisan inspector:test

Go to (https://app.inspector.dev/home)[https://app.inspector.dev/home] to explore your demo data.


By default Inspector monitors:

  • Database interactions
  • Queued Jobs execution
  • Artisan commands
  • Email sent
  • Notifications
  • Unhandled Exceptions

We turned on the light in the 50% of our app executed in background. The next step is to monitor all transactions generated by user interactions.

Incoming Web Requests monitoring

To activate monitoring also when your app is executed due to an incoming http request you can use the WebRequestMonitoring middleware.

It works like any other Laravel middleware you are familiar to so you are free to decide which routes need to be monitored based on your routes configuration or on your personal monitoring preferences.

The most easy way to cover all your application routes is attaching the middleware in the App\Http\Kernel class. :

/**
 * The application's route middleware groups.
 *
 * @var array
 */
protected $middlewareGroups = [
    'web' => [
       ...,
       \Inspector\Laravel\Middleware\WebRequestMonitoring::class,
    ],

    'api' => [
       ...,
       \Inspector\Laravel\Middleware\WebRequestMonitoring::class,
    ]
]
Enter fullscreen mode Exit fullscreen mode

Instantly you will see transactions streams in your project’s dashboard:

and for each transaction you can monitor what your application is executing in real-time:

Enrich your timeline

Inspector monitors database query, background jobs, artisan commands by default, but could be many critical statements in your code that need to be monitored in terms of performance and error:

  • Http calls to external services
  • Function that deals with files (pdf, excel, images)

Thanks to our package you can add custom segments in your timeline in addition to those detected by default, to measure the impact that an hidden code block has on a transaction's performance.

Let me show you a real life example.

Suppose you have a queued job that executes some database checks and an http request to an external service.

Job and queries are measured automatically, but it could be interesting to monitor and measure the execution of the http request and activate alerting if somethings goes wrong. Simply use the Inspector helper function:

class TagUserAsActive extends Job
{
    /** @param User $user */
    protected $user;

    // Monitring an external HTTP requests
    public function handle()
    {
        inspector()->addSegment(function () {

            $this->guzzle->post('/mail-marketing/add_tag', [
                'email' => $this->user->email,
                'tag' => 'active',
            ]);

        }, 'http');
    }
}
Enter fullscreen mode Exit fullscreen mode

You will see the impact of the new segment in your transaction timeline in real time:

Errors & Exceptions Alerting

By default, every exception fired in your Laravel app will be reported automatically to be sure you’re alerted for unpredictable errors in real time.

I wish that every change I make to my code could be perfect. But the reality is, this is not always the case. Some errors appear immediately after an update, while others pop up unpredictably. It’s an unfortunate fact of life for developers which often also depends on problems caused by the connection between our application and other services.

However, Inspector makes my job easier. It automates the detection of unknown issues so I no longer need to manually check the status of my apps continuously or wait reports directly from users. If something goes wrong I’ll receive a notification in real time, and after each release I can stay informed about the impact of the latest code refactor.

If your code fires an exception but you don’t want to block the execution, you can report the error to inspector manually for private monitoring about availability of the external system.


try {

   // Your dangerous code here...

} catch (GuzzleException $exception) {
   inspector()->reportException($exception)
}
Enter fullscreen mode Exit fullscreen mode

Furthermore, if the http request fails, you will be alerted in real time in your inbox to take a look at the error as it appears.

You even get access to detailed information gathered by Inspector in real time:

Conclusion

When a customer reports to you that something isn’t working, it forces you to drop whatever you are doing and start trying to reproduce the scenario, then recapture and reanalyze the logs in your own toolset.

Getting a true picture of what’s happening can require hours or, based on my experience, even days. Inspector can make a huge difference in terms of efficiency, productivity and customers happiness.

By delegating bug discovery to an automatic monitoring tool, it solves 90% of the problems in the half the time, before users even know about them.


Thank you so much for reading it. To make Inspector more sophisticated and mature, it will not be possible to accomplish without your help. Don’t hesitate to share your thoughts on the comment below or drop in live chat on our website! Let’s make it together.

Thank you for all your support!

Homepage: https://www.inspector.dev

Facebook: https://www.facebook.com/inspector.realtime/

Twitter: @inspector_rt

Contact me: valerio@inspector.dev

Discussion (1)

Collapse
mgmgpyaesonewin profile image
Pyae Sone Win

This looks amazing. I am definitely going to use it!

Forem Open with the Forem app