PHPackages                             adobrovolsky97/illuminar - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Debugging &amp; Profiling](/categories/debugging)
4. /
5. adobrovolsky97/illuminar

ActiveLibrary[Debugging &amp; Profiling](/categories/debugging)

adobrovolsky97/illuminar
========================

Debug tool for Laravel Framework

v1.3.4(7mo ago)2397.1k1MITPHPPHP &gt;=7.4

Since Jan 25Pushed 7mo ago2 watchersCompare

[ Source](https://github.com/adobrovolsky97/illuminar)[ Packagist](https://packagist.org/packages/adobrovolsky97/illuminar)[ RSS](/packages/adobrovolsky97-illuminar/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (5)Versions (25)Used By (0)

Illuminar
=========

[](#illuminar)

Illuminar is a Laravel package that provides a set of watchers to track various activities in your application. It is designed to help developers monitor and debug their applications more effectively.

[![299806977-260b3bd6-db1d-469c-968f-2c68dd2a82af](https://private-user-images.githubusercontent.com/136475533/299820590-119599fe-8fec-4657-995e-0b54684f56a4.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUxMTkyNTAsIm5iZiI6MTc3NTExODk1MCwicGF0aCI6Ii8xMzY0NzU1MzMvMjk5ODIwNTkwLTExOTU5OWZlLThmZWMtNDY1Ny05OTVlLTBiNTQ2ODRmNTZhNC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNDAyJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDQwMlQwODM1NTBaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT04ZTQ0NThmYzBhYmUyM2MyYWNiNTNjYTY1NWUwMjEyMmE5YWZiODNlYmM5MjBkNTQ0Mzk3NDA3YzNiZTM0NDc2JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.5F1JMDObA-r6x8d3PUQT4JxgcCcgoE-gYMFm4zbZxl0)](https://private-user-images.githubusercontent.com/136475533/299820590-119599fe-8fec-4657-995e-0b54684f56a4.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUxMTkyNTAsIm5iZiI6MTc3NTExODk1MCwicGF0aCI6Ii8xMzY0NzU1MzMvMjk5ODIwNTkwLTExOTU5OWZlLThmZWMtNDY1Ny05OTVlLTBiNTQ2ODRmNTZhNC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNDAyJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDQwMlQwODM1NTBaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT04ZTQ0NThmYzBhYmUyM2MyYWNiNTNjYTY1NWUwMjEyMmE5YWZiODNlYmM5MjBkNTQ0Mzk3NDA3YzNiZTM0NDc2JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.5F1JMDObA-r6x8d3PUQT4JxgcCcgoE-gYMFm4zbZxl0)Features
--------

[](#features)

- [**Dumps**](#dumps)
- [**DB Queries**](#db-queries--slow-queries-tracking): all queries including slow, duplicated, group duplicated queries
- [**Model Events Tracking**](#model-events-tracking)
- [**Jobs Tracking**](#jobs-tracking)
- [**Events Tracking**](#events-tracking)
- [**Cache Tracking**](#cache-tracking)
- [**Sent Mail Tracking &amp; Mailable Previews**](#sent-mail-tracking--mailable-previews)
- [**HTTP Request Tracking**](#http-request-tracking)
- [**Environment Variables**](#environment-variables)
- [**Exceptions Tracking**](#exceptions-tracking)

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require adobrovolsky97/illuminar
```

If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php

```
Adobrovolsky97\Illuminar\ServiceProvider::class,
```

Configuration
-------------

[](#configuration)

You can configure Illuminar by publishing its configuration file:

```
php artisan vendor:publish --provider="Adobrovolsky97\Illuminar\ServiceProvider"
```

This will publish required `assets` to `public/vendor/illuminar` and `illuminar.php` config file to your `config` directory. In this file, you can enable or disable Illuminar and configure its watchers.

Usage
-----

[](#usage)

### Enabling Illuminar

[](#enabling-illuminar)

Illuminar is enabled when `ILLUMINAR_ENABLED=true` in your `.env` file.

Debug data can be viewed at the `APP_URL/illuminar` route.

### Dumps

[](#dumps)

Illuminar provides a `illuminar()->dump(...$args)` function that can be used to dump variables to the illuminar screen. It is similar to the `dd` helper function, but it does not terminate the script execution.

There is a blade directive `@illuminar(...$args)` that can be used to dump variables to the illuminar screen from blade templates.

It is possible to add custom tags and colors to the dump, so it is easier to find it in the dump list.

```
illuminar()->dump($user, $anotherUser)->tag('users')->red(); // This will add a dump with a red border and a "users" tag
illuminar()->dump('Hello World');
illuminar()->dump(['foo' => 'bar'])->tag('array')->orange();
illuminar()
->dump(function () {
    return 'Hello World';
})
->tag('closure')
->green();
illuminar()->dump('Some data')->die(); // This one will terminate the script execution
```

### DB Queries &amp; Slow Queries Tracking

[](#db-queries--slow-queries-tracking)

Illuminar can track all DB queries and slow queries. It will display the query, bindings, execution time, and query caller.

```
illuminar()->trackQueries(); // Enables DB queries tracking
User::all(); // This query will be tracked
illuminar()->stopTrackingQueries(); // Disables DB queries tracking

User::all(); // This query will not be tracked

illuminar()->trackSlowQueries(); // Enables slow queries tracking
User::all(); // This query will be tracked only if its execution time is more than x ms (execution time taken from the config)
illuminar()->stopTrackingSlowQueries(); // Disables slow queries tracking

User::query()
    ->where('name', 'John Doe')
    ->illuminar() // Allows to dump query while building it
    ->where('is_active', true)
    ->illuminar() // Will contain additional where clause
    ->get();
```

### Model Events Tracking

[](#model-events-tracking)

Illuminar can track all model events. It will display the event name, model event caller and attributes changes.

By default, it is tracking: 'restored', 'updated', 'created', 'deleted'. It is possible to update it in the config file.

```
illuminar()->trackModelEvents(); // Enables model events tracking

$user = User::first();
$user->update(['name' => 'John Doe']); // This event will be tracked
$user->delete();

illuminar()->stopTrackingModelEvents(); // Disables model events tracking

User::create(['name' => 'John Doe']); // This event will not be tracked
```

### Jobs Tracking

[](#jobs-tracking)

Illuminar can track all jobs. It will display the job name, job caller, job status, and job payload.

```
illuminar()->trackJobs(); // Enables jobs tracking
Job::dispatch();
illuminar()->stopTrackingJobs(); // Disables jobs tracking

Job::dispatch(); // This job will not be tracked
```

### Events Tracking

[](#events-tracking)

Illuminar can track all events. It will display the event name, event caller, and event payload.

```
illuminar()->trackEvents(); // Enables events tracking
event(new UserRegistered($user)); // This event will be tracked
illuminar()->stopTrackingEvents(); // Disables events tracking

event(new UserRegistered($user)); // This event will not be tracked
```

### Cache Tracking

[](#cache-tracking)

Illuminar can track all cache operations. It will display the cache operation name, cache operation caller, and cache operation payload.

```
illuminar()->trackCaches(); // Enables cache tracking
Cache::put('key', 'value', 60); // This cache operation will be tracked
illuminar()->stopTrackingCaches(); // Disables cache tracking

Cache::put('key', 'value', 60); // This cache operation will not be tracked
```

### Sent Mail Tracking &amp; Mailable Previews

[](#sent-mail-tracking--mailable-previews)

Illuminar can track all sent mails. It will display the mail subject, mail recipient, mail sender, and mail payload, also it is possible to view mail content after it is being sent or event without sending it.

```
illuminar()->trackMails(); // Enables mail tracking
Mail::to('recipient@illuminar.com')->send(new WelcomeMail()); // This mail will be tracked
illuminar()->stopTrackingMails(); // Disables mail tracking

Mail::to('recipient@illuminar.com')->send(new WelcomeMail()); // This mail will not be tracked

illuminar()->mailable(new WelcomeMail()); // Displays mailable preview
```

### HTTP Request Tracking

[](#http-request-tracking)

Illuminar can track all HTTP requests. It will display the request method, request url, request headers, request payload, and request caller.

```
illuminar()->trackHttpRequests(); // Enables request tracking
Http::get('https://illuminar.com'); // This request will be tracked
illuminar()->stopTrackingHttpRequests(); // Disables request tracking

Http::get('https://illuminar.com'); // This request will not be tracked
```

### Environment Variables

[](#environment-variables)

Illuminar can display all environment variables.

```
illuminar()->showEnv(); // Enables environment variables display
```

### Exceptions Tracking

[](#exceptions-tracking)

Illuminar can track all exceptions. It will display the exception data.

```
illuminar()->trackExceptions(); // Enables exceptions tracking
throw new Exception('Something went wrong'); // This exception will be tracked
illuminar()->stopTrackingExceptions(); // Disables exceptions tracking

throw new Exception('Something went wrong'); // This exception will not be tracked
```

Illuminar stores data to the `storage/illuminar` directory and the data is being re-written on each request.

It could be used to debug the application not only on local but also on dev or production as it does not store a lot of data so the database will not be overloaded and could be easily disabled with .env variable.

License
-------

[](#license)

The Illuminar package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance64

Regular maintenance activity

Popularity33

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~29 days

Recently: every ~142 days

Total

22

Last Release

216d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/646ee7ed5fc7ff61f0dbd620d97abb20d550cbf5c8e9b5f9886a89c3af83107a?d=identicon)[adobrovolsky97](/maintainers/adobrovolsky97)

---

Top Contributors

[![adobrovolsky97](https://avatars.githubusercontent.com/u/136475533?v=4)](https://github.com/adobrovolsky97 "adobrovolsky97 (27 commits)")[![advolsky](https://avatars.githubusercontent.com/u/117436049?v=4)](https://github.com/advolsky "advolsky (3 commits)")

---

Tags

laraveldebugprofilerdebugger

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/adobrovolsky97-illuminar/health.svg)

```
[![Health](https://phpackages.com/badges/adobrovolsky97-illuminar/health.svg)](https://phpackages.com/packages/adobrovolsky97-illuminar)
```

###  Alternatives

[barryvdh/laravel-debugbar

PHP Debugbar integration for Laravel

19.1k124.3M624](/packages/barryvdh-laravel-debugbar)[fruitcake/laravel-debugbar

PHP Debugbar integration for Laravel

19.1k662.9k29](/packages/fruitcake-laravel-debugbar)[fruitcake/laravel-telescope-toolbar

Toolbar for Laravel Telescope based on Symfony Web Profiler

8041.6M3](/packages/fruitcake-laravel-telescope-toolbar)[recca0120/laravel-tracy

A Laravel Package to integrate Nette Tracy Debugger

388283.0k3](/packages/recca0120-laravel-tracy)[laracraft-tech/laravel-xhprof

Easy XHProf setup to profile your laravel application!

235321.4k](/packages/laracraft-tech-laravel-xhprof)[daylerees/anbu

The Anbu profiler for Laravel 4.

3054.9k](/packages/daylerees-anbu)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
