README

About Doppar Insight

Note: This repository contains the core code of the Doppar framework Insight package. If you want to build an application using Doppar, visit the main Doppar repository.

Screenshots

Queries	Session
Main Toolbar

Installation

Install the package via Composer:

composer require doppar/insight

The service provider will be automatically registered via package discovery.

Configuration

Basic Setup

The profiler is automatically enabled in development mode. No additional configuration is required!

However, you can customize the behavior by publishing the configuration file:

php pool vendor:publish --provider="Doppar\Insight\ProfilerServiceProvider"

Registration

If you disabled package discovery, add the service provider manually in config/app.php:

'providers' => [
    // ...
    Doppar\Insight\ProfilerServiceProvider::class,
],

Storage & Retention

The profiler automatically stores request data as JSON files in storage/framework/profiler. To prevent disk space issues, old files are automatically deleted after the retention period (1 day by default).

You can customize the retention period in your config/insight.php:

return [
    'retention_days' => 7, // Keep data for 7 days
];

The cleanup runs automatically once per day when new profiler data is stored.

Usage

Once installed, the profiler toolbar will automatically appear at the bottom of your HTML pages in development mode.

Collectors

Doppar Insight uses collectors to gather data. Available collectors:

TimeMemoryCollector - Tracks execution time and memory usage
RequestCollector - Collects request information
ResponseCollector - Collects response information
SqlCollector - Profiles database queries
CacheCollector - Tracks cache operations
LogCollector - Captures application logs
SessionCollector - Inspects session data
AuthCollector - Shows authentication information
HttpCollector - HTTP protocol details
DopparCollector - Framework version and environment

Production

Do not use this package in production.

Contributing

Thank you for considering contributing to the Doppar framework! The contribution guide can be found in the Doppar documentation.

Code of Conduct

In order to ensure that the Doppar community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The Doppar framework is open-sourced software licensed under the MIT license.

doppar / insight

Maintainers

Details