Getting Started

Minimal Setup

Installation:

composer require barryvdh/laravel-debugbar --dev

Publish the config file:

php artisan vendor:publish --provider="Barryvdh\Debugbar\ServiceProvider" --tag="config"

Enable Debug Mode: Set APP_DEBUG=true in your .env file.
First Use Case: Trigger a request (e.g., visit a route or run a command). The debug bar will appear at the bottom of the page, displaying default collectors like Queries, Messages, Views, and Route.

New Feature: SQL query backtrace entries now include editor links (e.g., IDE links) for direct navigation to the query's source code.

Key Starting Points

Viewing Data: Click tabs in the debug bar to inspect queries, logs, or request data.
Custom Messages: Use Debugbar::info(), Debugbar::error(), or the debug() helper to log data.
Timing Operations: Use start_measure(), stop_measure(), or measure() to profile code execution.
SQL Query Debugging: Click on query entries in the Queries tab to jump directly to the relevant code in your IDE (if configured).

Implementation Patterns

Core Workflows

Debugging Queries:
- Enable the Queries collector (default) to inspect SQL queries and execution times.
- New Feature: Click on a query to open the corresponding file and line in your IDE (e.g., VS Code, PHPStorm) via editor links.
- Example: Identify slow queries by sorting the Queries tab by duration.

Logging Custom Data:

Use the Messages collector to log variables or objects:

Debugbar::info(['user_id' => auth()->id(), 'action' => 'login']);

Or via helpers:
```
debug('Custom message', $variable);
```

Profiling Performance:

Measure execution time for critical sections:

Debugbar::startMeasure('render_view');
// Code to profile...
Debugbar::stopMeasure('render_view');

Use measure() for one-liners:

Debugbar::measure('long_operation', function() {
    // Heavy operation...
});

Handling Exceptions:

Log exceptions manually:

try {
    // Risky code...
} catch (\Exception $e) {
    Debugbar::addThrowable($e);
}

AJAX Requests:
- Enable capture_ajax: true in config/debugbar.php to track AJAX calls.
- View history via the folder icon in the debug bar.

Integration Tips

Conditional Debugging: Disable collectors in production or for specific environments:
```
if (app()->environment('local')) {
    debugbar()->enable();
}
```

Custom Collectors: Extend functionality by creating a custom collector:

use DebugBar\DataCollector\DataCollector;
use DebugBar\DataCollector\Renderable;

class MyCollector implements DataCollector, Renderable {
    public function collect() { /* Logic */ }
    public function getWidgets() { /* Render */ }
}

Debugbar::addCollector(new MyCollector());

Console Usage: Enable debug bar for CLI commands:

use Barryvdh\Debugbar\Facades\Debugbar;

public function handle() {
    Debugbar::enable();
    // Command logic...
}

Twig Integration: Replace dump() with debug() in Twig templates:
```
{{ debug(user) }}
```
Editor Links for Queries: Ensure your IDE supports editor links (e.g., VS Code, PHPStorm) and configure remote_sites_path and local_sites_path in config/debugbar.php for seamless navigation:
```
'editor_links' => [
    'remote_sites_path' => [
        '~/Projects/myapp' => '/myapp',
    ],
    'local_sites_path' => [
        '/var/www/myapp' => '/myapp',
    ],
],
```

Gotchas and Tips

Common Pitfalls

Performance Overhead:
- Debugbar slows down requests due to data collection. Disable unused collectors in production:
```
'collectors' => [
    'queries' => false, // Disable if not needed
]
```
Storage Security:
- Never enable storage.open in production. It exposes request history to unauthorized users.
- Use IP-based callbacks to restrict access:
```
'storage' => [
    'open' => function ($request) {
        return $request->ip() === '127.0.0.1';
    },
]
```
AJAX Auto-Show:
- Disable ajax_handler_auto_show if AJAX requests cause UI flickering:
```
'ajax_handler_auto_show' => false,
```
Editor Links Configuration:
- Ensure remote_sites_path and local_sites_path are correctly mapped for editor links to work. Misconfigurations may break navigation.
- Example for Docker/Homestead:
```
'editor_links' => [
    'remote_sites_path' => [
        '~/code/myapp' => '/myapp',
    ],
],
```
Collector Conflicts:
- Some collectors (e.g., logs, cache) may duplicate data. Disable redundant collectors:
```
'collectors' => [
    'logs' => false, // If using the 'messages' collector
]
```

Debugging Tips

Disable Collectors Temporarily: Use runtime disable/enable to isolate issues:

debugbar()->disable(); // Disable all collectors
Debugbar::info('Test'); // Won't appear
debugbar()->enable();  // Re-enable

Clear Storage: Delete storage/debugbar to reset request history (for file driver).
Check for Errors:
- Ensure APP_DEBUG=true is set.
- Verify no JavaScript errors block the debug bar (check browser console).
- For editor links, ensure your IDE supports the vscode:// or phpstorm:// protocol.
Custom Collector Debugging:
- Implement DebugBar\DataCollector\Renderable for custom UI.
- Use Debugbar::getData() to inspect collected data:
```
dd(Debugbar::getData());
```

Advanced Tips

ServerTiming Headers: Enable add_ajax_timing to integrate with Chrome DevTools:
```
'add_ajax_timing' => true,
```
Dark/Light Mode: Force a theme via .env:
```
DEBUGBAR_THEME=dark
```
Livewire Integration: Enable the livewire collector to debug Livewire components:
```
'collectors' => [
    'livewire' => true,
]
```

Environment-Specific Config: Use environment variables to toggle features:

DEBUGBAR_COLLECT_JOBS=true

'collectors' => [
    'jobs' => env('DEBUGBAR_COLLECT_JOBS', false),
]

Custom Storage Drivers: Implement DebugBar\Storage\StorageInterface for custom storage (e.g., Redis):
```
'storage' => [
    'driver' => 'redis',
    'connection' => 'cache',
]
```
Leveraging Editor Links:
- Configure your IDE to recognize the debugbar:// protocol for seamless navigation.
- Example for VS Code: Add a custom URI handler or use extensions like "URI Handler" to open files directly from the debug bar.

Laravel Debugbar Laravel Package