Php Error Insight Laravel Package

Getting Started

Install the package via Composer:

composer require raffaelecarelle/php-error-insight

Laravel auto-discovery registers the service provider. Publish the config file:

php artisan vendor:publish --tag=error-insight-config

Review config/error-insight.php to enable/disable capture, set the storage driver (log, database, or custom), and configure filters. The first use case is to capture unhandled exceptions and enrich them with request context, user data, and environment details so you can debug faster in development and staging.

Implementation Patterns

• Integrate with Laravel’s exception handler – In App\Exceptions\Handler, call the package’s reporter from report() before or after the default logging. This ensures all exceptions flow through Error Insight.
• Custom reporters for specific exceptions – Use the package’s reporter contract to create tailored handlers for domain exceptions (e.g., payment failures) that attach extra metadata like order IDs.
• Filter sensitive data – Configure the sensitive_keys array in the config to scrub passwords, tokens, and personal data from request payloads and headers.
• Group and deduplicate – Leverage built-in fingerprinting to group similar errors. Override the fingerprint generator if you need to include custom context (e.g., tenant ID) in the grouping.
• Dashboard or log review – If the package provides a UI, register its routes and middleware; otherwise, tail the dedicated log channel or query the insights table to review recent errors.
• Queue-friendly – When reporting from queued jobs, ensure the package captures job context (class, payload) and that your queue workers are restarted after config changes.

Gotchas and Tips

• Performance overhead – Capturing full request/response data can be heavy. Enable sampling in production or restrict capture to specific environments.
• Sensitive data leakage – Always audit the sensitive_keys config; the package may capture request bodies by default. Use the should_report callback to skip health checks or bots.
• Config caching – After changing config/error-insight.php, run php artisan config:clear (or config:cache in production) to avoid stale settings.
• Extension points – Most behavior is customizable via contracts: custom insight providers, formatters, and storage drivers. Bind your implementations in a service provider.
• Debugging missing insights – Check that the exception handler is actually calling the reporter, verify the storage driver is writable, and confirm that the enabled flag is true for the current environment.
• Upgrading – Version 1.0.18 is a patch release; no breaking changes are expected. Run your test suite after upgrading and review the changelog for any bug fixes that might affect your integration.