Redirected from /barryvdh/laravel-debugbar
Laravel Debugbar

https://github.com/fruitcake/laravel-debugbar
Admin
Laravel Debugbar is a debugging tool that integrates PHP Debug Bar with Laravel to display detailed...
Tokens:18,666
Snippets:162
Trust Score:8.1
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Debugbar skill for AI agents

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/usage.md

Use this command to install the Debugbar skill into your project's agent directories. Options include specifying the agent type with --agent, using --symlink for updates, or --force to overwrite.

```bash
php artisan debugbar:install-skill
```

--------------------------------

### Install Laravel Debugbar with Composer

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/installation.md

Use this command to add the package to your project. It's recommended to install it only for development environments.

```shell
composer require fruitcake/laravel-debugbar --dev
```

--------------------------------

### Measure execution time with Debugbar Facade

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Track performance by starting and stopping measures or wrapping operations in a closure.

```php
Debugbar::startMeasure('render','Time for rendering');
Debugbar::stopMeasure('render');
Debugbar::addMeasure('now', LARAVEL_START, microtime(true));
Debugbar::measure('My long operation', function() {
    // Do something…
});
```

--------------------------------

### Get Javascript renderer

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Retrieve the renderer instance when manual injection is configured.

```php
$renderer = Debugbar::getJavascriptRenderer();
```

--------------------------------

### Use helper functions for debugging

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Utilize global helper functions and collection methods for quick debugging and timing.

```php
// All arguments will be dumped as a debug message
debug($var1, $someString, $intValue, $object);

// `$collection->debug()` will return the collection and dump it as a debug message. Like `$collection->dump()`
collect([$var1, $someString])->debug();

debugbar()->startMeasure('render','Time for rendering');
debugbar()->stopMeasure('render');
debugbar()->addMeasure('now', LARAVEL_START, microtime(true));
debugbar()->measure('My long operation', function() {
    // Do something…
});
```

--------------------------------

### Publish package configuration

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Run this artisan command to copy the package configuration file to your local config directory.

```shell
php artisan vendor:publish --provider='Fruitcake\LaravelDebugbar\ServiceProvider'
```

--------------------------------

### Analyze database queries via CLI

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/resources/boost/skills/debug-using-debugbar/SKILL.md

Commands to view query overviews, inspect specific statements, and generate EXPLAIN plans or execution results. The output includes flags for slow or failed queries and reports on duplicate or repeated query shapes.

```bash
# Overview with duplicate detection, slow flags and failed statements
php artisan debugbar:queries {id}

# Backtrace and params for a specific statement
php artisan debugbar:queries {id} --statement=N

# EXPLAIN plan or re-execute a SELECT
php artisan debugbar:queries {id} --statement=N --explain
php artisan debugbar:queries {id} --statement=N --result
```

--------------------------------

### Initialize Debugbar Search and Navigation

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Sets up event listeners for keyboard shortcuts (F3, Ctrl+F, Esc, Enter) to control search and navigation within the debugbar's data display. It also handles focus management for the search input.

```javascript
setTimeout(function () { state.reset(); collapseAll(root); resetHighlightedNodes(root); if ('' === searchQuery) { counter.textContent = '0 of 0'; return; } var classMatches = [
  "sf-dump-str", "sf-dump-key", "sf-dump-public", "sf-dump-protected", "sf-dump-private", 
].map(xpathHasClass).join(' or '); var xpathResult = doc.evaluate('.//span\[ ' + classMatches + ' \]\[contains(translate(child::text(), ' + xpathString(searchQuery.toUpperCase()) + ', ' + xpathString(searchQuery.toLowerCase()) + '), ' + xpathString(searchQuery.toLowerCase()) + ') \]', root, null, XPathResult.ORDERED_NODE_ITERATOR_TYPE, null); while (node = xpathResult.iterateNext()) state.nodes.push(node); showCurrent(state); }, 400);
});
Array.from(search.querySelectorAll('.sf-dump-search-input-next, .sf-dump-search-input-previous')).forEach(function (btn) {
  addEventListener(btn, 'click', function (e) {
    e.preventDefault();
    -1 !== e.target.className.indexOf('next') ? state.next() : state.previous();
    searchInput.focus();
    collapseAll(root);
    showCurrent(state);
  })
});
addEventListener(root, 'keydown', function (e) {
  var isSearchActive = !/\bsf-dump-search-hidden\b/.test(search.className);
  if ((114 === e.keyCode && !isSearchActive) || (isCtrlKey(e) && 70 === e.keyCode)) {
    /* F3 or CMD/CTRL + F */
    if (70 === e.keyCode && document.activeElement === searchInput) {
      /* * If CMD/CTRL + F is hit while having focus on search input, * the user probably meant to trigger browser search instead. * Let the browser execute its behavior: */
      return;
    }
    e.preventDefault();
    search.className = search.className.replace(/\bsf-dump-search-hidden\b/, '');
    searchInput.focus();
  } else if (isSearchActive) {
    if (27 === e.keyCode) {
      /* ESC key */
      search.className += ' sf-dump-search-hidden';
      e.preventDefault();
      resetHighlightedNodes(root);
      searchInput.value = '';
    } else if ( (isCtrlKey(e) && 71 === e.keyCode) /* CMD/CTRL + G */
      || 13 === e.keyCode /* Enter */
      || 114 === e.keyCode /* F3 */
    ) {
      e.preventDefault();
      e.shiftKey ? state.previous() : state.next();
      collapseAll(root);
      showCurrent(state);
    }
  }
});
```

--------------------------------

### Enable Debugbar in Configuration

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/installation.md

This configuration snippet shows how to enable the Debugbar. It defaults to `APP_DEBUG`'s value but can be overridden by `DEBUGBAR_ENABLED` in your .env file or directly in the config.

```php
/*
 |--------------------------------------------------------------------------
 | Debugbar Settings
 |--------------------------------------------------------------------------
 |
 | Debugbar is enabled by default, when debug is set to true in app.php.
 | You can override the value by setting enable to true or false instead of null.
 |
 | You can provide an array of URI's that must be ignored (eg. 'api/*')
 |
 */

'enabled' => env('DEBUGBAR_ENABLED', null),
'hide_empty_tabs' => false, // Hide tabs until they have content
'except' => [
    'telescope*',
    'horizon*',
],
```

--------------------------------

### Debug and optimize workflow

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/resources/boost/skills/debug-using-debugbar/SKILL.md

A step-by-step workflow for identifying, inspecting, and drilling into request data to resolve performance or error issues.

```bash
php artisan debugbar:find --issues --max=50
```

```bash
php artisan debugbar:get {id}
```

```bash
php artisan debugbar:get {id} --collector=exceptions
```

```bash
php artisan debugbar:queries {id}
```

--------------------------------

### Configure Database Query Options

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Customize the behavior of the database query collector, including parameter rendering, path exclusions, backtrace usage, and query limits. Set `with_params` to true to render SQL with parameters substituted.

```php
  'options' => [
        // ...
        'db' => [
            'with_params'       => true,   // Render SQL with the parameters substituted
            'exclude_paths'     => [
                // 'vendor/laravel/framework/src/Illuminate/Session', // Exclude sessions queries
            ],
            'backtrace'         => true,   // Use a backtrace to find the origin of the query in your files.
            'backtrace_exclude_paths' => [],   // Paths to exclude from backtrace. (in addition to defaults)
            'timeline'          => false,  // Add the queries to the timeline
            'duration_background'  => true,   // Show shaded background on each query relative to how long it took to execute.
            'explain' => [
                'enabled' => false,
            ],
            'hints'             => false,   // Show hints for common mistakes
            'show_copy'         => true,    // Show copy button next to the query,
            'slow_threshold'    => false,   // Only track queries that last longer than this time in ms
            'memory_usage'      => false,   // Show queries memory usage
            'soft_limit'       => 100,      // After the soft limit, no parameters/backtrace are captured
            'hard_limit'       => 500,      // After the hard limit, queries are ignored
        ],
        // ...
    ],
```

--------------------------------

### Find requests with filters

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/resources/boost/skills/debug-using-debugbar/SKILL.md

Commands to list and filter captured requests based on URI patterns, HTTP methods, and performance issue thresholds.

```bash
# List recent requests (shows summary with status, duration, memory, query count)
php artisan debugbar:find

# Filter by URI pattern (fnmatch) and/or HTTP method
php artisan debugbar:find --uri="/api/*" --method=POST

# Only show requests with issues (exceptions, slow queries, duplicates, errors)
php artisan debugbar:find --issues --max=50

# Customize issue thresholds (defaults: --min-queries=50, --min-duration=1000, --min-duplicates=2)
php artisan debugbar:find --issues --min-queries=10 --min-duration=500

# Threshold options also work standalone, filtering on just that criteria
php artisan debugbar:find --min-queries=20
```

--------------------------------

### Publish Debugbar Configuration

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/installation.md

Run this Artisan command to publish the Debugbar's configuration file to your project, allowing for further customization.

```shell
php artisan vendor:publish --provider="Fruitcake\LaravelDebugbar\ServiceProvider"
```

--------------------------------

### Configure Database Query Options

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Customize database query collection, including parameter substitution, path exclusion, backtrace usage, and timeline integration.

```php
  'options' => [
        // ...
        'db' => [
            'with_params'       => true,   // Render SQL with the parameters substituted
            'exclude_paths'     => [       // Paths to exclude entirely from the collector
                // 'vendor/laravel/framework/src/Illuminate/Session', // Exclude sessions queries
            ],
            'backtrace'         => true,   // Use a backtrace to find the origin of the query in your files.
            'backtrace_exclude_paths' => [],   // Paths to exclude from backtrace. (in addition to defaults)
            'timeline'          => false,  // Add the queries to the timeline
            'duration_background'  => true,   // Show shaded background on each query relative to how long it took to execute.
            'explain' => [
                'enabled' => false,
            ],
            'hints'             => false,   // Show hints for common mistakes
            'show_copy'         => true,    // Show copy button next to the query,
            'slow_threshold'    => false,   // Only track queries that last longer than this time in ms
            'memory_usage'      => false,   // Show queries memory usage
            'soft_limit'       => 100,      // After the soft limit, no parameters/backtrace are captured
            'hard_limit'       => 500,      // After the hard limit, queries are ignored
        ],
        // ...
    ],
```

--------------------------------

### Configure View Collector Options

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Control view collection, including timeline integration, data display, grouping of similar views, and path exclusion.

```php
    'options' => [
        'views' => [
            'timeline' => false,    // Add the views to the timeline (Experimental)
            'data' => false,        //true for all data, 'keys' for only names, false for no parameters.
            'group' => 50,          // Group duplicate views. Pass value to auto-group, or true/false to force
            'exclude_paths' => [
                'vendor/filament'   // Exclude Filament components by default
            ],
        ],
    ]
```

--------------------------------

### Configure Debugbar Storage Settings

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/features.md

Manage how Debugbar stores request data. File storage is used by default, but Redis, PDO, or custom drivers can be configured. Warning: Enabling 'storage.open' can expose sensitive data in non-local environments.

```php
    /*
     |--------------------------------------------------------------------------
     | Storage settings
     |--------------------------------------------------------------------------
     |
     | DebugBar stores data for session/ajax requests.
     | You can disable this, so the debugbar stores data in headers/session,
     | but this can cause problems with large data collectors.
     | By default, file storage (in the storage folder) is used. Redis and PDO
     | can also be used. For PDO, run the package migrations first.
     |
     | Warning: Enabling storage.open will allow everyone to access previous
     | request, do not enable open storage in publicly available environments!
     | Specify a callback if you want to limit based on IP or authentication.
     | Leaving it to null will allow localhost only.
     */
    'storage' => [
        'enabled'    => true,
        'open'       => env('DEBUGBAR_OPEN_STORAGE'), // bool/callback.
        'driver'     => 'file', // redis, file, pdo, socket, custom
        'path'       => storage_path('debugbar'), // For file driver
        'connection' => null,   // Leave null for default connection (Redis/PDO)
        'provider'   => '', // Instance of StorageInterface for custom driver
        'hostname'   => '127.0.0.1', // Hostname to use with the "socket" driver
        'port'       => 2304, // Port to use with the "socket" driver
    ],
```

--------------------------------

### Configure Timeline Collector Options

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Adjust timeline collector settings, specifically for memory usage calculation accuracy.

```php
    'options' => [
        'time' => [
            'memory_usage' => false,  // Calculated by subtracting memory start and end, it may be inaccurate
        ],
    ]
```

--------------------------------

### Configure streamed response capture

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/usage.md

Enable streamed response capture in config/debugbar.php to allow the toolbar to load data when headers are committed early. This requires storage to be enabled.

```php
// config/debugbar.php
'capture_streamed' => env('DEBUGBAR_CAPTURE_STREAMED', false),
'streamed_content_types' => ['text/event-stream'],
```

--------------------------------

### Configure Route Collector Options

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Enable or disable the display of the complete route information on the debug bar.

```php
    'options' => [
        'route' => [
            'label' => true,  // show complete route on bar
        ],
    ],
```

--------------------------------

### Debugbar Editor Configuration

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/features.md

Set your preferred editor for opening file links in Debugbar. Defaults to 'phpstorm' if DEBUGBAR_EDITOR is not set.

```php
/*
    |--------------------------------------------------------------------------
    | Editor
    |--------------------------------------------------------------------------
    |
    | Choose your preferred editor to use when clicking file name.
    |
    | Supported: "phpstorm", "vscode", "vscode-insiders", "vscode-remote",
    |            "vscode-insiders-remote", "vscodium", "textmate", "emacs",
    |            "sublime", "atom", "nova", "macvim", "idea", "netbeans",
    |            "xdebug", "espresso"
    |
    */

    'editor' => env('DEBUGBAR_EDITOR') ?: env('IGNITION_EDITOR', 'phpstorm'),

    /*
    |--------------------------------------------------------------------------
    | Remote Path Mapping
    |--------------------------------------------------------------------------
    |
    | If you are using a remote dev server, like Laravel Homestead, Docker, or
    | even a remote VPS, it will be necessary to specify your path mapping.
    |
    | Leaving one, or both of these, empty or null will not trigger the remote
    | URL changes and Debugbar will treat your editor links as local files.
    |
    | "remote_sites_path" is an absolute base path for your sites or projects
    | in Homestead, Vagrant, Docker, or another remote development server.
    |
    | Example value: "/home/vagrant/Code"
    |
    | "local_sites_path" is an absolute base path for your sites or projects
    | on your local computer where your IDE or code editor is running on.
    |
    | Example values: "/Users/<name>/Code", "C:\\Users\\<name>\\Documents\\Code"
    |
    */

    'remote_sites_path' => env('DEBUGBAR_REMOTE_SITES_PATH'),
    'local_sites_path' => env('DEBUGBAR_LOCAL_SITES_PATH', env('IGNITION_LOCAL_SITES_PATH')),

```

--------------------------------

### Inspect request data via CLI

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/resources/boost/skills/debug-using-debugbar/SKILL.md

Use these commands to retrieve request summaries or full data for specific collectors. If an incorrect collector name is provided, the command will list available collectors for that request.

```bash
# Summary of all collectors (available collectors depend on config)
php artisan debugbar:get latest
php artisan debugbar:get {id}

# Full data for a specific collector
php artisan debugbar:get {id} --collector=exceptions
```

--------------------------------

### Enable and Configure AJAX Handlers

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Initialize and bind the `AjaxHandler` to `fetch` and `XMLHttpRequest` to capture AJAX requests. This allows the Debugbar to display data from asynchronous operations.

```javascript
phpdebugbar.restoreState();
```

```javascript
phpdebugbar.enableAjaxHandlerTab();
```

```javascript
phpdebugbar.ajaxHandler = new PhpDebugBar.AjaxHandler(phpdebugbar, undefined, true);
```

```javascript
phpdebugbar.ajaxHandler.bindToFetch();
```

```javascript
phpdebugbar.ajaxHandler.bindToXHR();
```

--------------------------------

### Manually Add Exceptions to Debugbar

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Demonstrates how to manually add throwables to the Exceptions collector using the debugbar instance.

```php
debugbar()->addThrowable($throwable);
```

--------------------------------

### Configure Debugbar Data Mapping

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Use `setDataMap` to define how various data points are collected and displayed in the Debugbar. This includes request details, exceptions, messages, performance metrics, and framework-specific data.

```javascript
phpdebugbar.setDataMap({ "request": ["request.data", {}], "request:badge": ["request.badge", null], "request_uri": ["request.data.uri", ], "request_uri:tooltip": ["request.tooltip", {}], "exceptions": ["exceptions.exceptions", []], "exceptions:badge": ["exceptions.count", null], "messages": ["messages.messages", []], "messages:badge": ["messages.count", null], "time": ["time.duration_str", '0ms'], "timeline": ["time", {}], "memory": ["memory.peak_usage_str", '0B'], "version": ["laravel.version", ], "version:tooltip": ["laravel.tooltip", {}], "views": ["views", []], "views:badge": ["views.nb_templates", 0], "queries": ["queries", []], "queries:badge": ["queries.nb_statements", 0], "models": ["models", {}], "models:badge": ["models.count", 0], "emails": ["symfonymailer_mails.mails", []], "emails:badge": ["symfonymailer_mails.count", null], "gate": ["gate.messages", []], "gate:badge": ["gate.count", null], "cache": ["cache", {}], "cache:badge": ["cache.nb_measures", null], "jobs": ["jobs", {}], "jobs:badge": ["jobs.count", 0] });
```

--------------------------------

### Register Debugbar Facade

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/installation.md

To use the Debugbar facade for logging messages, add this alias within the `register` method of your `app/Providers/AppServiceProvider.php` class.

```php
public function register(): void
{
    $loader = \Illuminate\Foundation\AliasLoader::getInstance();
    $loader->alias('Debugbar', \Fruitcake\LaravelDebugbar\Facades\Debugbar::class);
}
```

--------------------------------

### Register ServiceProvider without Auto-Discovery (Laravel 11+)

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/installation.md

If your project does not use auto-discovery, manually add the ServiceProvider to the `bootstrap/providers.php` file for Laravel 11 or newer.

```php
Fruitcake\LaravelDebugbar\ServiceProvider::class,
```

--------------------------------

### Configure Logs Collector

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Specify additional log files to monitor with the Logs collector in config/debugbar.php.

```php
    'options' => [
        'logs' => [
            'file' => null, // Additional files
        ],
     ],
```

--------------------------------

### Find queued jobs and Artisan commands

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/resources/boost/skills/debug-using-debugbar/SKILL.md

Filter requests specifically for background jobs or CLI commands by setting the method flag.

```bash
php artisan debugbar:find --method=JOB      # queued jobs
php artisan debugbar:find --method=CLI      # artisan commands
```

--------------------------------

### Log exceptions with Debugbar Facade

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Capture and log exceptions using the addThrowable method.

```php
try {
    throw new Exception('foobar');
} catch (Exception $e) {
    Debugbar::addThrowable($e);
}
```

--------------------------------

### Configure Auth Collector Options

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Customize the Auth collector in config/debugbar.php to show the user's name/email and the guards used.

```php
    'options' => [
        'auth' => [
            'show_name' => true,   // Also show the users name/email in the debugbar
            'show_guards' => true, // Show the guards that are used
        ],
    ],
```

--------------------------------

### Log messages with Debugbar Facade

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Use the Debugbar Facade to log messages using PSR-3 levels or custom labels.

```php
Debugbar::info($object);
Debugbar::error('Error!');
Debugbar::warning('Watch out…');
Debugbar::addMessage('Another message', 'mylabel');
```

--------------------------------

### Retrieve Debugbar data in JSON format

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/resources/boost/skills/debug-using-debugbar/SKILL.md

Use the --json flag with read commands to output data in a machine-readable format. This preserves exact numbers and is easier to parse than standard table output.

```bash
php artisan debugbar:find --issues --json     # array of requests, each with an `issues` list
php artisan debugbar:queries {id} --json      # statements plus `duplicate_groups` and `n_plus_one_groups`
php artisan debugbar:get {id} --json          # raw collector data (`--raw` is the same thing)
```

--------------------------------

### Debugbar CSS Styling (Light Theme)

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Provides CSS rules for styling the Debugbar in a light theme, including styles for preformatted text, search inputs, and various data types.

```css
.phpdebugbar pre.sf-dump .sf-dump-search-wrapper > input.sf-dump-search-input {
  padding: 3px;
  height: 21px;
  font-size: 12px;
  border-right: none;
  border-top-left-radius: 3px;
  border-bottom-left-radius: 3px;
  color: #000;
  min-width: 15px;
  width: 100%;
}
.phpdebugbar pre.sf-dump .sf-dump-search-wrapper > .sf-dump-search-input-next, .phpdebugbar pre.sf-dump .sf-dump-search-wrapper > .sf-dump-search-input-previous {
  background: #F2F2F2;
  outline: none;
  border-left: none;
  font-size: 0;
  line-height: 0;
}
.phpdebugbar pre.sf-dump .sf-dump-search-wrapper > .sf-dump-search-input-next {
  border-top-right-radius: 3px;
  border-bottom-right-radius: 3px;
}
.phpdebugbar pre.sf-dump .sf-dump-search-wrapper > .sf-dump-search-input-next > svg, .phpdebugbar pre.sf-dump .sf-dump-search-wrapper > .sf-dump-search-input-previous > svg {
  pointer-events: none;
  width: 12px;
  height: 12px;
}
.phpdebugbar pre.sf-dump .sf-dump-search-wrapper > .sf-dump-search-count {
  display: inline-block;
  padding: 0 5px;
  margin: 0;
  border-left: none;
  line-height: 21px;
  font-size: 12px;
}.phpdebugbar pre.sf-dump, .phpdebugbar pre.sf-dump .sf-dump-default{
  word-wrap: break-word;
  white-space: pre-wrap;
  word-break: normal
}.phpdebugbar pre.sf-dump .sf-dump-num{
  font-weight:bold;
  color:#1299DA
}
.phpdebugbar pre.sf-dump .sf-dump-const{
  font-weight:bold
}
.phpdebugbar pre.sf-dump .sf-dump-str{
  font-weight:bold;
  color:#3A9B26
}
.phpdebugbar pre.sf-dump .sf-dump-note{
  color:#1299DA
}
.phpdebugbar pre.sf-dump .sf-dump-ref{
  color:#7B7B7B
}
.phpdebugbar pre.sf-dump .sf-dump-public{
  color:#000000
}
.phpdebugbar pre.sf-dump .sf-dump-protected{
  color:#000000
}
.phpdebugbar pre.sf-dump .sf-dump-private{
  color:#000000
}
.phpdebugbar pre.sf-dump .sf-dump-meta{
  color:#B729D9
}
.phpdebugbar pre.sf-dump .sf-dump-key{
  color:#3A9B26
}
.phpdebugbar pre.sf-dump .sf-dump-index{
  color:#1299DA
}
.phpdebugbar pre.sf-dump .sf-dump-ellipsis{
  color:#A0A000
}
.phpdebugbar pre.sf-dump .sf-dump-virtual{
  font-style:italic
}
.phpdebugbar pre.sf-dump .sf-dump-ns{
  user-select:none;
}
.phpdebugbar pre.sf-dump .sf-dump-ellipsis-note{
  color:#1299DA
}
```

--------------------------------

### Initialize Laravel Debugbar

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Instantiates the DebugBar object with auto theme detection and hides empty tabs. This is the primary JavaScript initialization for the debug bar.

```javascript
var phpdebugbar = new PhpDebugBar.DebugBar({"theme":"auto","hideEmptyTabs":true});
```

--------------------------------

### Configure Request Collector Options

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Specify sensitive data paths to be hidden in the Request collector, such as passwords.

```php
    'options' => [
        'symfony_request' => [
            'hiddens' => [], // hides sensitive values using array paths, example: request_request.password
        ],
    ],
```

--------------------------------

### Initialize Sfdump JavaScript

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

This JavaScript code initializes the Sfdump functionality for the debug bar. It adds a CSS class to the document element and sets up event listeners for toggling and expanding/collapsing debug information.

```javascript
Sfdump = window.Sfdump || (function (doc) {
    doc.documentElement.classList.add('sf-js-enabled');
    var rxEsc = /(\[.\*+?^${}()|\\[\\\]\/\\\\])/g,
        idRx = /\\bsf-dump-\d+-ref\[012\]\\w+\\b/,
        keyHint = 0 <= navigator.platform.toUpperCase().indexOf('MAC') ? 'Cmd' : 'Ctrl',
        addEventListener = function (e, n, cb) {
            e.addEventListener(n, cb, false);
        };
    if (!doc.addEventListener) {
        addEventListener = function (element, eventName, callback) {
            element.attachEvent('on' + eventName, function (e) {
                e.preventDefault = function () { e.returnValue = false; };
                e.target = e.srcElement;
                callback(e);
            });
        };
    }
    function toggle(a, recursive) {
        var s = a.nextSibling || {},
            oldClass = s.className,
            arrow,
            newClass;
        if (/\\bsf-dump-compact\\b/.test(oldClass)) {
            arrow = '▼';
            newClass = 'sf-dump-expanded';
        } else if (/\\bsf-dump-expanded\\b/.test(oldClass)) {
            arrow = '▶';
            newClass = 'sf-dump-compact';
        } else {
            return false;
        }
        if (doc.createEvent && s.dispatchEvent) {
            var event = doc.createEvent('Event');
            event.initEvent('sf-dump-expanded' === newClass ? 'sfbeforedumpexpand' : 'sfbeforedumpcollapse', true, false);
            s.dispatchEvent(event);
        }
        a.lastChild.innerHTML = arrow;
        s.className = s.className.replace(/\\bsf-dump-(compact|expanded)\\b/, newClass);
        if (recursive) {
            try {
                a = s.querySelectorAll('.' + oldClass);
                for (s = 0; s < a.length; ++s) {
                    if (-1 == a[s].className.indexOf(newClass)) {
                        a[s].className = newClass;
                        a[s].previousSibling.lastChild.innerHTML = arrow;
                    }
                }
            } catch (e) {}
        }
        return true;
    }
    function collapse(a, recursive) {
        var s = a.nextSibling || {},
            oldClass = s.className;
        if (/\\bsf-dump-expanded\\b/.test(oldClass)) {
            toggle(a, recursive);
            return true;
        }
        return false;
    }
    function expand(a, recursive) {
        var s = a.nextSibling || {},
            oldClass = s.className;
        if (/\\bsf-dump-compact\\b/.test(oldClass)) {
            toggle(a, recursive);
            return true;
        }
        return false;
    }
    function collapseAll(root) {
        var a = root.querySelector('a.sf-dump-toggle');
        if (a) {
            collapse(a, true);
            expand(a);
            return true;
        }
        return false;
    }
    function reveal(node) {
        var previous, parents = [];
        while ((node = node.parentNode || {}) && (previous = node.previousSibling) && 'A' === previous.tagName) {
            parents.push(previous);
        }
        if (0 !== parents.length) {
            parents.forEach(function (parent) {
                expand(parent);
            });
            return true;
        }
        return false;
    }
    function highlight(root, activeNode, nodes) {
        resetHighlightedNodes(root);
        Array.from(nodes || []).forEach(function (node) {
            if (!/\\bsf-dump-highlight\\b/.test(node.className)) {
                node.className = node.className + ' sf-dump-highlight';
            }
        });
        if (!/\\bsf-dump-highlight-active\\b/.test(activeNode.className)) {
            activeNode.className = activeNode.className + ' sf-dump-highlight-active';
        }
    }
    function resetHighlightedNodes(root) {
        Array.from(root.querySelectorAll('.sf-dump-str, .sf-dump-key, .sf-dump-public, .sf-dump-protected, .sf-dump-private')).forEach(function (strNode) {
            strNode.className = strNode.className.replace(/\\bsf-dump-highlight\\b/, '');
            strNode.className = strNode.className.replace(/\\bsf-dump-highlight-active\\b/, '');
        });
    }
    return function (root, x) {
        root = doc.getElementById(root);
        var indentRx = new RegExp('^(' + (root.getAttribute('data-indent-pad') || ' ').replace(rxEsc, '\\$1') + ')+', 'm'),
            options = {
                "maxDepth": 1,
                "maxStringLength": 160,
                "fileLinkFormat": false
            },
            elt = root.getElementsByTagName('A'),
            len = elt.length,
            i = 0,
            s,
            h,
            t = [];
        while (i < len) t.push(elt[i++]);
        for (i in x) {
            options[i] = x[i];
        }
        function a(e, f) {
            addEventListener(root, e, function (e, n) {
                if ('A' == e.target.tagName) {
                    f(e.target, e);
                } else if ('A' == e.target.parentNode.tagName) {
                    f(e.target.parentNode, e);
                } else {
                    n = /\\bsf-dump-ellipsis\\b/.test(e.target.className) ? e.target.parentNode : e.target;
                    if ((n = n.nextElementSibling) && 'A' == n.tagName) {
                        if (!/\\bsf-dump-toggle\\b/.test(n.className)) {
                            n = n.nextElementSibling || n;
                        }
                        f(n, e, true);
                    }
                }
            });
        }
        function isCtrlKey(e) {
            return e.ctrlKey || e.metaKey;
        }
        function xpathString(str) {
            var parts = str.match(/[^'"']+|['"]/g).map(function (part) {
                if (''' == part) return "'\\\'"';
                if ('"' == part) return '"' + '\\"' + "'";
                return "'" + part + "'";
            });
            return "concat(" + parts.join(',') + ", '')";
        }
        function xpathHasClass(className) {
            return "contains(concat(' ', normalize-space(@class), ' '), ' " + className + " ')";
        }
        a('mouseover', function (a, e, c) {
            if (c) {
                e.target.style.cursor = "pointer";
            }
        });
        a('click', function (a, e, c) {
            if (/\\bsf-dump-toggle\\b/.test(a.className)) {
                e.preventDefault();
                if (!toggle(a
```

--------------------------------

### Artisan CLI Commands for Request Inspection

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/usage.md

Use these commands to interact with stored requests via the CLI. Requires debugbar.storage.enabled to be set to true in the configuration.

```bash
php artisan debugbar:find --issues   # list stored requests, or only ones with issues
php artisan debugbar:get {id}        # show a request summary, or a single --collector
php artisan debugbar:queries {id}    # analyse queries, with N+1 detection and EXPLAIN
php artisan debugbar:clear           # clear the storage
```

--------------------------------

### Add Version Indicator to Debugbar

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Adds a 'version' indicator to the Debugbar, displaying the Laravel version with a Laravel brand icon. Positioned on the right.

```javascript
phpdebugbar.addIndicator("version", new PhpDebugBar.DebugBar.Indicator({"icon":"brand-laravel"}), "right");
```

--------------------------------

### Enable Debugbar in Console Commands

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/usage.md

Manually enable the debugbar within console commands to log data for later inspection in the UI.

```php
debugber()->enable();
```

--------------------------------

### Configure Memory Usage Collector

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Adjust memory collection settings in config/debugbar.php, including resetting peak usage, baseline, and precision.

```php
    'options' => [
        'memory' => [
            'reset_peak' => false,     // run memory_reset_peak_usage before collecting
            'with_baseline' => false,  // Set boot memory usage as memory peak baseline
            'precision' => 0,          // Memory rounding precision
        ],
    ]
```

--------------------------------

### Remove legacy Laravel Debugbar package

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Use this command if you are migrating from the previous barryvdh/laravel-debugbar package.

```shell
composer remove barryvdh/laravel-debugbar --dev --no-scripts
```

--------------------------------

### Enable or Disable Debugbar at Runtime

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Use these methods to toggle the Debugbar during application execution. Note that enabling it adds collectors and potential overhead.

```php
\Debugbar::enable();
\Debugbar::disable();
```

--------------------------------

### Add Custom Tabs to Debugbar

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Use `addTab` to register new tabs with custom icons, titles, and widgets. This allows for the display of specific data like queries, models, emails, gate events, cache, and jobs.

```javascript
bar.addTab("queries", new PhpDebugBar.DebugBar.Tab({"icon":"database","title":"Queries", "widget": new PhpDebugBar.Widgets.LaravelQueriesWidget()}));
```

```javascript
phpdebugbar.addTab("models", new PhpDebugBar.DebugBar.Tab({"icon":"box","title":"Models", "widget": new PhpDebugBar.Widgets.TableVariableListWidget()}));
```

```javascript
phpdebugbar.addTab("emails", new PhpDebugBar.DebugBar.Tab({"icon":"inbox","title":"Mails", "widget": new PhpDebugBar.Widgets.MailsWidget()}));
```

```javascript
phpdebugbar.addTab("gate", new PhpDebugBar.DebugBar.Tab({"icon":"logs","title":"Gate", "widget": new PhpDebugBar.Widgets.MessagesWidget()}));
```

```javascript
phpdebugbar.addTab("cache", new PhpDebugBar.DebugBar.Tab({"icon":"clipboard-text","title":"Cache", "widget": new PhpDebugBar.Widgets.LaravelCacheWidget()}));
```

```javascript
phpdebugbar.addTab("jobs", new PhpDebugBar.DebugBar.Tab({"icon":"briefcase","title":"Jobs", "widget": new PhpDebugBar.Widgets.TableVariableListWidget()}));
```

--------------------------------

### Configure Events Collector

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Enable or disable the collection of event data and listeners for the Events collector in config/debugbar.php.

```php
    'options' => [
        'events' => [
            'data' => false, // collect events data, listeners
        ],
    ],
```

--------------------------------

### Debugbar CSS Styling (Dark Theme)

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Provides CSS rules for styling the Debugbar in a dark theme, overriding default styles for a different aesthetic. Includes styles for various data types and elements.

```css
.phpdebugbar[data-theme='dark'] pre.sf-dump, pre.sf-dump .sf-dump-default{
  background-color:#18171B;
  color:#FF8400;
  line-height:1.2em;
  font:12px Menlo, Monaco, Consolas, monospace;
  word-wrap: break-word;
  white-space: pre-wrap;
  position:relative;
  z-index:99999;
  word-break: break-all
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-num{
  font-weight:bold;
  color:#1299DA
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-const{
  font-weight:bold
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-virtual{
  font-style:italic
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-str{
  font-weight:bold;
  color:#56DB3A
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-note{
  color:#1299DA
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-ref{
  color:#A0A0A0
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-public{
  color:#FFFFFF
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-protected{
  color:#FFFFFF
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-private{
  color:#FFFFFF
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-meta{
  color:#B729D9
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-key{
  color:#56DB3A
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-index{
  color:#1299DA
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-ellipsis{
  color:#FF8400
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-ns{
  user-select:none;
}
.phpdebugbar[data-theme='dark'] pre.sf-dump .sf-dump-ellipsis-note{
  color:#1299DA
}
```

--------------------------------

### Configure Cache Collector

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/collectors.md

Enable or disable the collection of cache values for the Cache collector in config/debugbar.php.

```php
    'options' => [
        'cache' => [
            'values' => true, // collect cache values
        ],
    ],
```

--------------------------------

### Handle Click Events for Debugbar Interactions

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Centralized event listener for handling various click interactions within the Debugbar, including toggling data, expanding/collapsing strings, and navigation.

```javascript
addEventListener(root, 'click', function (e) {
    var elt = e.target;
    while (elt && elt !== root && !/^sf-dump-(toggle|ref|hover)$/.test(elt.className)) {
        elt = elt.parentNode;
    }
    if (!elt || elt.className.indexOf('sf-dump-toggle') === -1) {
        return;
    }
    e.preventDefault();
    var a = elt;
    var isCompact = /\bsf-dump-compact\b/.test(a.className);
    if (/\bsf-dump-ref\b/.test(a.className) && a.parentNode.parentNode && !isCompact) {
        var r = doc.getElementById(a.getAttribute('href').slice(1)),
            s = r.previousSibling,
            f = r.parentNode,
            t = a.parentNode;
        t.replaceChild(r, a);
        f.replaceChild(a, s);
        t.insertBefore(s, r);
        f = f.firstChild.nodeValue.match(indentRx);
        t = t.firstChild.nodeValue.match(indentRx);
        if (f && t && f[0] !== t[0]) {
            r.innerHTML = r.innerHTML.replace(new RegExp('^' + f[0].replace(rxEsc, '\\$1'), 'mg'), t[0]);
        }
        if (/\bsf-dump-compact\b/.test(r.className)) {
            toggle(s, isCtrlKey(e));
        }
    }
    if (c) {
    } else if (doc.getSelection) {
        try {
            doc.getSelection().removeAllRanges();
        } catch (e) {
            doc.getSelection().empty();
        }
    } else {
        doc.selection.empty();
    }
    if (/\bsf-dump-str-toggle\b/.test(a.className)) {
        e.preventDefault();
        e = a.parentNode.parentNode;
        e.className = e.className.replace(/\bsf-dump-str-(expand|collapse)\b/, a.parentNode.className);
    }
});

```

--------------------------------

### Set Debugbar Open Handler

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Configure the `OpenHandler` to specify the URL used for opening debug information. This is typically used to link to detailed views of specific requests or data points.

```javascript
phpdebugbar.setOpenHandler(new PhpDebugBar.OpenHandler({"url":"http:\/\/localhost\//_debugbar\/open"}));
```

--------------------------------

### Enable or Disable Debugbar at Runtime

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/usage.md

Use these methods to toggle the debugbar during application execution. Enabling it adds collectors, so it is recommended to keep it disabled in production.

```php
debugbar()->enable();
debugbar()->disable();
```

--------------------------------

### Add custom DataCollectors

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/readme.md

Register custom data collectors via the Facade or the Application container.

```php
Debugbar::addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));
// Or via the App container:
$debugbar = App::make('debugbar');
$debugbar->addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));
```

--------------------------------

### Add Data Set to Debugbar

Source: https://github.com/fruitcake/laravel-debugbar/blob/master/docs/overrides/main.html

Use `addDataSet` to manually add a collection of data to the Debugbar. This is useful for injecting custom data or for testing purposes, including metadata like request ID, timestamp, and method.

```javascript
phpdebugbar.addDataSet({"__meta":{"id":"01KE6YNS1G737D5PGHMQJVZKKE","datetime":"2026-01-05 11:29:00","utime":1767612540.052934,"method":"GET","uri":"\/docs","ip":"127.0.0.1"},"request":{"data":{"uri":"GET docs","file":{"value":"Users\/barry\/Sites\/laravel-debugbar\/tests\/DebugbarDocsTest.php:42-59","xdebug_link":{"url":"phpstorm:\/\/open?file=%2FUsers%2Fbarry%2FSites%2Flaravel-debugbar%2Ftests%2FDebugbarDocsTest.php&line=42","ajax":false,"filename":"DebugbarDocsTest.php","line":"42"}},"method":"GET","format":"html","content_type":"text\/html; charset=utf-8","status_text":"OK","status_code":"\u003Cpre class=sf-dump id=sf-dump-284496784 data-indent-pad=\u0022 \u0022\u003E\u003Cspan class=sf-dump-num\u003E200\u003C\/span\u003E\n\u003C\/pre\u003E\n","request_query":"\u003Cpre class=sf-dump id=sf-dump-1896855412 data-indent-pad=\u0022 \u0022\u003E[]\n\u003C\/pre\u003E\n","request_request":"\u003Cpre class=sf-dump id=sf-dump-14564081 data-indent-pad=\u0022 \u0022\u003E[]\n\u003C\/pre\u003E\n","request_files":"\u003Cpre class=sf-dump id=sf-dump-1363178519 data-indent-pad=\u0022 \u0022\u003E[]\n\u003C\/pre\u003E\n","request_headers":"\u003Cpre class=sf-dump id=sf-dump-1438531029 data-indent-pad=\u0022 \u0022\u003E\u003Cspan class=sf-dump-note\u003Earray:5\u003C\/span\u003E [\u003Csamp data-depth=1 class=sf-dump-expanded\u003E\n \"\u003Cspan class=sf-dump-key\u003Ehost\u003C\/span\u003E\u0022 =\u003E \u003Cspan class=sf-dump-note\u003Earray:1\u003C\/span\u003E [\u003Csamp data-depth=2 class=sf-dump-compact\u003E\n \u003Cspan class=sf-dump-index\u003E0\u003C\/span\u003E =\u003E \u0022\u003Cspan class=sf-dump-str title=\u00229 characters\u0022\u003Elocalhost\u003C\/span\u003E\u0022\n \u003C\/samp\u003E]\n \"\u003Cspan class=sf-dump-key\u003Euser-agent\u003C\/span\u003E\u0022 =\u003E \u003Cspan class=sf-dump-note\u003Earray:1\u003C\/span\u003E [\u003Csamp data-depth=2 class=sf-dump-compact\u003E\n \u003Cspan class=sf-dump-index\u003E0\u003C\/span\u003E =\u003E \u0022\u003Cspan class=sf-dump-str title=\u00227 characters\u0022\u003ESymfony\u003C\/span\u003E\u0022\n \u003C\/samp\u003E]\n \"\u003Cspan class=sf-dump-key\u003Eaccept\u003C\/span\u003E\u0022 =\u003E \u003Cspan class=sf-dump-note\u003Earray:1\u003C\/span\u003E [\u003Csamp data-depth=2 class=sf-dump-compact\u003E\n \u003Cspan class=sf-dump-index\u003E0\u003C\/span\u003E =\u003E \u0022\u003Cspan class=sf-dump-str title=\u002263 characters\u0022\u003Etext
```
Tokens:
Raw