sormagec/application-insights-laravel

Microsoft Azure Application Insights for Laravel 10+ - A fully maintained package for pushing telemetry to Azure Application Insights

Maintainers

Details

github.com/bsormagec/application-insights-laravel

Homepage

Source

Issues

Installs: 30

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 1

Open Issues: 0

pkg:composer/sormagec/application-insights-laravel

2.1.3 2025-12-01 17:02 UTC

Requires

MIT 952ea9fa217f60bb0466e602be53315efd8d606f

  • Burak Sormagec <bsormagec.woop@gmail.com>
  • Sahib <sahib.zer.woop@gmail.com>

loggingperformancemonitoringazurelaravelmicrosoftapmtelemetryApplication Insights

This package is auto-updated.

Last update: 2025-12-01 17:03:04 UTC

README

Latest Version on Packagist Total Downloads License

A fully maintained Laravel package for Microsoft Azure Application Insights integration. Push telemetry from your Laravel web app and APIs directly to Application Insights with queue support and separate handling for API and web routes.

Note: This is a fork of the original larasahib/application-insights-laravel package with bug fixes, improvements, and continued maintenance.

Features

  • ✅ Request Tracking - Automatic HTTP request monitoring
  • ✅ Exception Tracking - Automatic error reporting to Azure
  • ✅ Slow Query Tracking - Automatic slow database query monitoring
  • ✅ Failed Job Tracking - Automatic queue job failure reporting
  • ✅ Mail Tracking - Track sent emails
  • ✅ Custom Events - Track custom events and metrics
  • ✅ Trace Logging - Send log messages to Application Insights
  • ✅ Queue Support - Async telemetry via Laravel queues (Redis, etc.)
  • ✅ Client-Side JS - Browser telemetry collection
  • ✅ Laravel 10+ - Full support for modern Laravel versions

Requirements

  • PHP >= 8.1
  • Laravel >= 10.0
  • Guzzle >= 7.0

Installation

composer require sormagec/application-insights-laravel

The package will auto-register via Laravel's package discovery.

Configuration

1. Publish the configuration file

php artisan vendor:publish --tag=config --provider="Sormagec\AppInsightsLaravel\Providers\AppInsightsServiceProvider"

2. Set your Connection String

Add to your .env file:

# Get this from Azure Portal > Application Insights > Overview > Connection String
MS_AI_CONNECTION_STRING=InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://<region>.in.applicationinsights.azure.com/

# Queue delay in seconds (0 = sync, >0 = async via queue)
MS_AI_FLUSH_QUEUE_AFTER_SECONDS=5

# Enable debug logging (0 = disabled, 1 = enabled)
MS_AI_ENABLE_LOGGING=0

# Max query parameters to include in telemetry
MS_AI_MAX_QUERY_PARAMS=10

# Slow query threshold in milliseconds (queries slower than this are tracked)
MS_AI_DB_SLOW_MS=500

# Feature toggles (all enabled by default)
MS_AI_FEATURE_DB=true
MS_AI_FEATURE_JOBS=true
MS_AI_FEATURE_MAIL=true
MS_AI_FEATURE_HTTP=true

Where to find the Connection String

Azure Portal → Application Insights → Overview → Connection String

Usage

Request Tracking Middleware

Add the middleware to your app/Http/Kernel.php:

protected $middlewareGroups = [
    'web' => [
        // ... other middleware
        \Sormagec\AppInsightsLaravel\Middleware\AppInsightsWebMiddleware::class,
    ],

    'api' => [
        // ... other middleware
        \Sormagec\AppInsightsLaravel\Middleware\AppInsightsApiMiddleware::class,
    ],
];

Tracked Properties:

  • ajax - Whether the request is AJAX
  • ip - Client IP address
  • pjax - Whether the request is PJAX
  • secure - Whether HTTPS was used
  • route - Route name (if available)
  • user - User ID (if authenticated)
  • referer - HTTP referer

Exception Handler

Replace the base exception handler in app/Exceptions/Handler.php:

<?php

namespace App\Exceptions;

// Replace this line:
// use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

// With this:
use Sormagec\AppInsightsLaravel\Handlers\AppInsightsExceptionHandler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    // Your existing code...
}

Client-Side Telemetry

Add to your Blade layout (preferably in <head>):

{!! \AIClient::javascript() !!}

Custom Telemetry

// Track a custom event
\AIServer::trackEvent('UserRegistered', ['plan' => 'premium']);

// Track a trace message
\AIServer::trackTrace('User completed checkout', 1, ['orderId' => '12345']);

// Track an exception manually
\AIServer::trackException($exception, ['context' => 'payment']);

// Flush immediately (sync)
\AIServer::flush();

// Or use queue for async sending
\AIQueue::dispatch(\AIServer::getChannel()->getQueue())
    ->onQueue('appinsights-queue')
    ->delay(now()->addSeconds(5));

Queue Worker Setup

For async telemetry, run a dedicated queue worker:

php artisan queue:work redis --queue=appinsights-queue --sleep=3 --tries=3

For production (Supervisor example):

[program:appinsights-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/html/artisan queue:work redis --queue=appinsights-queue --sleep=3 --tries=3 --max-time=3600
autostart=true
autorestart=true
numprocs=1

Automatic Tracking Features

The following telemetry is collected automatically without any additional configuration:

Slow Database Queries

Queries slower than the configured threshold (MS_AI_DB_SLOW_MS, default 500ms) are automatically tracked as dependencies in Application Insights.

Tracked Properties:

  • db.sql - The SQL query (truncated for safety)
  • db.duration_ms - Query duration in milliseconds
  • db.connection - Database connection name

To disable: MS_AI_FEATURE_DB=false

Failed Queue Jobs

Failed queue jobs are automatically tracked as exceptions in Application Insights.

Tracked Properties:

  • job.name - The job class name
  • job.queue - The queue name
  • job.connection - Queue connection name
  • job.payload - Job payload (truncated)

To disable: MS_AI_FEATURE_JOBS=false

Sent Emails

Sent emails are tracked as custom events in Application Insights.

Tracked Properties:

  • mail.to - Number of recipients
  • mail.subject - Email subject
  • mail.class - Notification class name (if available)

To disable: MS_AI_FEATURE_MAIL=false

Publishing Assets

Configuration

php artisan vendor:publish --tag=config

JavaScript Assets

php artisan vendor:publish --tag=laravel-assets

Changelog

v2.1.0

  • ✨ Added slow database query tracking
  • ✨ Added failed queue job tracking
  • ✨ Added mail sent tracking
  • ✨ Added trackDbQuery() and trackDependency() methods
  • ✨ Added feature toggles for granular control
  • 📝 Updated documentation with new features

v2.0.0

  • 🔄 Forked and rebranded from larasahib/application-insights-laravel
  • 🐛 Fixed singleton issues causing multiple initializations
  • 🐛 Fixed Logger respecting enable_local_logging config
  • 🐛 Fixed ExceptionHandler lazy loading
  • ✨ Better default config values
  • 📝 Updated documentation

Previous versions

See original package history at larasahib/application-insights-laravel

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License. See LICENSE for more information.

Credits

  • Original package by Sahib - Thank you for creating and sharing this package with the community! 🙏
  • Maintained by Burak Sormagec

Acknowledgments

Special thanks to Sahib for the original larasahib/application-insights-laravel package. This fork continues the development with bug fixes and improvements while preserving the original architecture and design decisions.