Ignition

https://github.com/spatie/laravel-ignition
Admin
Ignition is a beautiful and customizable error page for Laravel applications, designed to track...
Tokens:6,098
Snippets:25
Trust Score:10
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Custom Solution Provider Example

Source: https://context7.com/spatie/laravel-ignition/llms.txt

An example implementation of a custom solution provider and a solution class, demonstrating how to register it with Ignition.

```APIDOC
## Custom Solution Provider Example

### Description
Example implementation of a custom solution provider and solution.

### Code Example
```php
namespace App\Solutions;

use Spatie\ErrorSolutions\Contracts\ProvidesSolution;
use Spatie\ErrorSolutions\Contracts\Solution;
use Illuminate\Database\QueryException;

class CustomDatabaseSolutionProvider implements ProvidesSolution
{
    public function canSolve(Throwable $throwable): bool
    {
        if (!$throwable instanceof QueryException) {
            return false;
        }

        return str_contains($throwable->getMessage(), 'Unknown database');
    }

    public function getSolutions(Throwable $throwable): array
    {
        return [new FixDatabaseConnectionSolution()];
    }
}

class FixDatabaseConnectionSolution implements Solution
{
    public function getSolutionTitle(): string
    {
        return 'Database does not exist';
    }

    public function getSolutionDescription(): string
    {
        return 'The database specified in your .env file does not exist. Create it or update your configuration.';
    }

    public function getDocumentationLinks(): array
    {
        return [
            'Laravel Database Configuration' => 'https://laravel.com/docs/database#configuration',
        ];
    }
}

// Register in config/ignition.php
'solution_providers' => [
    // ...existing providers
    \App\Solutions\CustomDatabaseSolutionProvider::class,
],
```
```

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

### Implement Custom Solution Provider and Solution in Laravel

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This PHP code provides an example of a custom solution provider and a corresponding solution for handling specific database errors in Laravel Ignition. The `CustomDatabaseSolutionProvider` checks for `QueryException` related to unknown databases, and `FixDatabaseConnectionSolution` offers a description and documentation link to resolve the issue. The provider must be registered in `config/ignition.php`.

```php
namespace App\Solutions;

use Spatie\ErrorSolutions\Contracts\ProvidesSolution;
use Spatie\ErrorSolutions\Contracts\Solution;
use Illuminate\Database\QueryException;

class CustomDatabaseSolutionProvider implements ProvidesSolution
{
    public function canSolve(Throwable $throwable): bool
    {
        if (!$throwable instanceof QueryException) {
            return false;
        }

        return str_contains($throwable->getMessage(), 'Unknown database');
    }

    public function getSolutions(Throwable $throwable): array
    {
        return [new FixDatabaseConnectionSolution()];
    }
}

class FixDatabaseConnectionSolution implements Solution
{
    public function getSolutionTitle(): string
    {
        return 'Database does not exist';
    }

    public function getSolutionDescription(): string
    {
        return 'The database specified in your .env file does not exist. Create it or update your configuration.';
    }

    public function getDocumentationLinks(): array
    {
        return [
            'Laravel Database Configuration' => 'https://laravel.com/docs/database#configuration',
        ];
    }
}

// Register in config/ignition.php
'solution_providers' => [
    // ...existing providers
    \App\Solutions\CustomDatabaseSolutionProvider::class,
],
```

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

### GET /_ignition/health-check

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Checks if the Ignition service is running and accessible.

```APIDOC
## GET /_ignition/health-check

### Description
Checks if Ignition is running.

### Method
GET

### Endpoint
`http://localhost/_ignition/health-check`

### Response
#### Success Response (200)
- **OK** - Indicates that Ignition is running.

### Response Example
`200 OK`
```

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

### Health Check Endpoint using cURL

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This cURL command shows how to perform a health check on the Laravel Ignition service. It's a simple GET request to the `/_ignition/health-check` endpoint, used to verify if Ignition is running and accessible. A successful response is indicated by a `200 OK` status.

```bash
# Check if Ignition is running
curl http://localhost/_ignition/health-check

# Response: 200 OK
```

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

### Generate Custom Solution Provider and Solution in Laravel

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This snippet outlines the Artisan commands used to create custom solution providers and solutions within a Laravel project. It first requires enabling command registration in the `.env` file. These commands bootstrap the necessary files for defining custom error solutions that Ignition can leverage.

```bash
# Enable command registration first
# In .env: REGISTER_IGNITION_COMMANDS=true

php artisan make:solution-provider CustomDatabaseSolutionProvider
php artisan make:solution FixDatabaseConnectionSolution
```

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

### Generating Custom Solution Provider

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Instructions on how to generate a solution provider and a custom solution class using Artisan commands.

```APIDOC
## Generating Custom Solution Provider

### Description
Generate a solution provider and a custom solution using Artisan commands.

### Usage
1. Enable command registration first:
   In `.env`: `REGISTER_IGNITION_COMMANDS=true`

2. Run the following commands:
   ```bash
   php artisan make:solution-provider CustomDatabaseSolutionProvider
   php artisan make:solution FixDatabaseConnectionSolution
   ```
```

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

### Publish Ignition and Flare Configuration Files

Source: https://context7.com/spatie/laravel-ignition/llms.txt

These Artisan commands are used to publish the configuration files for Laravel Ignition and Flare. Publishing allows you to customize settings related to error reporting and tracking.

```bash
php artisan vendor:publish --tag=ignition-config

# Publish Flare configuration (for error tracking service)
php artisan vendor:publish --tag=flare-config
```

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

### Test Flare Integration using Artisan Command

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Tests the integration of Flare by sending a test exception to the Flare service. This command verifies that the Flare key is set and the logging driver is configured correctly. It provides feedback on the success of the test.

```bash
# Send test exception to Flare
php artisan flare:test
```

```text
// Example output:
// ✅ Flare key specified
// ✅ The Flare logging driver was configured correctly.
//
// We tried to send an exception to Flare. Please check if it arrived!

```

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

### Remote Development Path Mapping

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Configuration details for setting up path mappings in `.env` and `config/ignition.php` for remote development environments like Docker or Homestead.

```APIDOC
## Remote Development Setup

### Path Mapping Configuration

### Description
Configure `.env` and `config/ignition.php` for remote development path mapping.

### Usage
```php
// .env for Docker/Homestead/Remote development
IGNITION_REMOTE_SITES_PATH=/home/vagrant/Code
IGNITION_LOCAL_SITES_PATH=/Users/yourname/Projects

// config/ignition.php
'remote_sites_path' => env('IGNITION_REMOTE_SITES_PATH', base_path()),
'local_sites_path' => env('IGNITION_LOCAL_SITES_PATH', ''),

// For PHPStorm remote development
'editor' => 'phpstorm-remote',
```
```

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

### Execute Solution Endpoint using cURL

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This cURL command demonstrates how to interact with Laravel Ignition's API to execute a specific solution, such as generating an application key. It highlights the need for requests to originate from a local IP address and specifies the JSON payload structure required for the request.

```bash
# Execute a runnable solution (only from local IP)
curl -X POST http://localhost/_ignition/execute-solution \
  -H "Content-Type: application/json" \
  -d '{
    "solution": "Spatie\\LaravelIgnition\\Solutions\\GenerateAppKey",
    "parameters": {}
  }'
```

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

### Configure Laravel Ignition Settings

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This PHP code snippet shows the configuration options for Laravel Ignition, which can be found in the `config/ignition.php` file. It allows customization of the editor, theme, sharing features, runnable solutions, OpenAI integration, solution providers, and runtime data recorders.

```php
// config/ignition.php
return [
    // Set preferred editor for "Open in Editor" buttons
    'editor' => env('IGNITION_EDITOR', 'phpstorm'), // phpstorm, vscode, sublime, etc.

    // Theme preference
    'theme' => env('IGNITION_THEME', 'auto'), // light, dark, auto

    // Enable/disable error sharing functionality
    'enable_share_button' => env('IGNITION_SHARING_ENABLED', true),

    // Enable runnable solutions (auto-fixes) in local environment
    'enable_runnable_solutions' => env('IGNITION_ENABLE_RUNNABLE_SOLUTIONS'),

    // Configure OpenAI for AI-powered solution suggestions
    'open_ai_key' => env('IGNITION_OPEN_AI_KEY'),

    // Solution providers to load
    'solution_providers' => [
        \Spatie\LaravelIgnition\Solutions\SolutionProviders\MissingAppKeySolutionProvider::class,
        \Spatie\LaravelIgnition\Solutions\SolutionProviders\TableNotFoundSolutionProvider::class,
        \Spatie\LaravelIgnition\Solutions\SolutionProviders\ViewNotFoundSolutionProvider::class,
        // ... more providers
    ],

    // Recorders for capturing runtime context
    'recorders' => [
        \Spatie\LaravelIgnition\Recorders\DumpRecorder\DumpRecorder::class,
        \Spatie\LaravelIgnition\Recorders\JobRecorder\JobRecorder::class,
        \Spatie\LaravelIgnition\Recorders\LogRecorder\LogRecorder::class,
        \Spatie\LaravelIgnition\Recorders\QueryRecorder\QueryRecorder::class,
    ],
];
```

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

### POST /_ignition/execute-solution

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Executes a runnable solution provided by Ignition. This endpoint should only be accessed from a local IP address.

```APIDOC
## POST /_ignition/execute-solution

### Description
Executes a runnable solution (only from local IP).

### Method
POST

### Endpoint
`http://localhost/_ignition/execute-solution`

### Parameters
#### Request Body
- **solution** (string) - Required - The fully qualified class name of the solution to execute.
- **parameters** (object) - Optional - An object containing the parameters for the solution.

### Request Example
```json
{
  "solution": "Spatie\\LaravelIgnition\\Solutions\\GenerateAppKey",
  "parameters": {}
}
```
```

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

### Recording Variable Dumps

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Demonstrates how variable dumps are automatically recorded using the `dump()` function and how to access these recorded dumps via the `DumpRecorder`.

```APIDOC
## Recording Variable Dumps

### Description
Dumps are automatically recorded when using `dump()`.

### Usage
```php
use Spatie\LaravelIgnition\Recorders\DumpRecorder\DumpRecorder;

// Dumps are automatically recorded when using dump()
public function debugFeature()
{
    $user = User::find(1);
    dump($user); // Captured by DumpRecorder

    $permissions = $user->permissions()->get();
    dump($permissions); // Also captured

    $config = config('app');
    dump($config); // Also captured

    throw new Exception('Debug point reached');
    // Error page shows all three dumps with file locations
}

// Access recorded dumps
$dumps = app(DumpRecorder::class)->getDumps();
// [
//     ['html' => '<pre>User {#123 ...}</pre>', 'file' => '/app/Controller.php', 'line' => 42],
//     ['html' => '<pre>Collection {#456 ...}</pre>', 'file' => '/app/Controller.php', 'line' => 45],
//     ['html' => '<pre>array:50 [...]]</pre>', 'file' => '/app/Controller.php', 'line' => 48],
// ]
```
```

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

### Configure Flare Integration Settings

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This PHP code snippet details the configuration for Flare integration within Laravel Ignition, located in `config/flare.php`. It includes settings for the Flare API key and various middleware used to enrich error reports with data like IP addresses, Git information, logs, queries, and job details, while also censoring sensitive request data.

```php
// config/flare.php
return [
    // Flare API key for production error tracking
    'key' => env('FLARE_KEY'),

    // Middleware to enrich error reports
    'flare_middleware' => [
        \Spatie\FlareClient\FlareMiddleware\RemoveRequestIp::class,
        \Spatie\FlareClient\FlareMiddleware\AddGitInformation::class,
        \Spatie\LaravelIgnition\FlareMiddleware\AddLogs::class => [
            'maximum_number_of_collected_logs' => 200,
        ],
        \Spatie\LaravelIgnition\FlareMiddleware\AddQueries::class => [
            'maximum_number_of_collected_queries' => 200,
            'report_query_bindings' => true,
        ],
        \Spatie\LaravelIgnition\FlareMiddleware\AddJobs::class => [
            'max_chained_job_reporting_depth' => 5,
        ],
        \Spatie\FlareClient\FlareMiddleware\CensorRequestBodyFields::class => [
            'censor_fields' => ['password', 'password_confirmation', 'api_token'],
        ],
        \Spatie\FlareClient\FlareMiddleware\CensorRequestHeaders::class => [
            'headers' => ['API-KEY', 'Authorization', 'Cookie', 'Set-Cookie'],
        ],
    ],

    // Control log event sending
    'send_logs_as_events' => true,
];
```

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

### Configure Path Mapping for Remote Development in Laravel Ignition

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This PHP configuration snippet shows how to set up path mapping for remote development environments like Docker or Homestead within Laravel Ignition. It involves defining `.env` variables for remote and local site paths and then referencing these in `config/ignition.php`. An option for PHPStorm remote development is also included.

```php
// .env for Docker/Homestead/Remote development
IGNITION_REMOTE_SITES_PATH=/home/vagrant/Code
IGNITION_LOCAL_SITES_PATH=/Users/yourname/Projects

// config/ignition.php
'remote_sites_path' => env('IGNITION_REMOTE_SITES_PATH', base_path()),
'local_sites_path' => env('IGNITION_LOCAL_SITES_PATH', ''),

// For PHPStorm remote development
'editor' => 'phpstorm-remote',
```

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

### Record Custom Events with Glow in PHP

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Records custom events with varying severity levels (INFO, WARNING, ERROR) and associated data using the Flare::glow() method. It also demonstrates setting context for error reports. Dependencies include SpatieFlareClientEnumsMessageLevels and SpatieLaravelIgnitionFacadesFlare. Input is event details and optional context data; output is a recorded event in Flare.

```php
use SpatieFlareClientEnumsMessageLevels;
use SpatieLaravelIgnitionFacadesFlare;

// Record informational breadcrumb
Flare::glow('User logged in', MessageLevels::INFO, [
    'user_id' => auth()->id(),
    'login_method' => 'oauth',
]);

// Record warning event
Flare::glow('API rate limit approaching', MessageLevels::WARNING, [
    'current_usage' => 950,
    'limit' => 1000,
    'resets_at' => now()->addHour(),
]);

// Record error event
Flare::glow('Payment processing failed', MessageLevels::ERROR, [
    'order_id' => $order->id,
    'amount' => $order->total,
    'error' => $exception->getMessage(),
]);

// In your controller
public function processPayment(Order $order)
{
    Flare::context('order_id', $order->id);
    Flare::context('payment_gateway', 'stripe');

    try {
        $charge = Stripe::charges()->create([
            'amount' => $order->total * 100,
            'currency' => 'usd',
        ]);

        Flare::glow('Payment successful', MessageLevels::INFO, [
            'charge_id' => $charge->id,
        ]);

        return response()->json(['success' => true]);
    } catch (StripeException $e) {
        Flare::glow('Stripe error occurred', MessageLevels::ERROR, [
            'error_code' => $e->getCode(),
            'error_message' => $e->getMessage(),
        ]);
        throw $e;
    }
}
```

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

### POST /_ignition/update-config

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Updates Ignition's configuration settings, such as theme and editor preferences.

```APIDOC
## POST /_ignition/update-config

### Description
Updates Ignition settings (theme, editor, etc.).

### Method
POST

### Endpoint
`http://localhost/_ignition/update-config`

### Parameters
#### Request Body
- **theme** (string) - Optional - The desired theme for Ignition (e.g., 'dark').
- **editor** (string) - Optional - The preferred code editor (e.g., 'vscode').

### Request Example
```json
{
  "theme": "dark",
  "editor": "vscode"
}
```
```

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

### Job Recorder

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Explains how failed jobs are automatically recorded by the `JobRecorder`, including customization of job recording depth and accessing job information.

```APIDOC
## Job Recorder

### Recording Failed Jobs

### Description
Job details are automatically captured on failure, and the chain of jobs is recorded.

### Usage
```php
use Spatie\LaravelIgnition\Recorders\JobRecorder\JobRecorder;

// Customize job recording depth
app(JobRecorder::class); // Default max_chained_job_reporting_depth is 5

// Job details are automatically captured on failure
class ProcessOrder implements ShouldQueue
{
    public function __construct(
        public Order $order,
        public bool $sendNotification = true
    ) {}

    public function handle()
    {
        // Process order logic
        throw new Exception('Job failed'); // Captures full job details
    }
}

// Chain of jobs is recorded
ProcessOrder::dispatch($order)
    ->chain([
        new SendOrderConfirmation($order),
        new UpdateInventory($order),
        new GenerateInvoice($order),
    ]);
// If any job fails, entire chain is visible in error report

// Access recorded job information
$job = app(JobRecorder::class)->getJob();
// [
//     'name' => 'App\Jobs\ProcessOrder',
//     'connection' => 'redis',
//     'queue' => 'default',
//     'data' => ['order' => [...], 'sendNotification' => true],
//     'chained' => [
//         ['name' => 'App\Jobs\SendOrderConfirmation', 'data' => [...]],
//         ['name' => 'App\Jobs\UpdateInventory', 'data' => [...]],
//     ],
// ]
```
```

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

### Configure Query Recorder in PHP

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Enables and customizes automatic SQL query recording within Laravel Ignition. The QueryRecorder can be configured to set the maximum number of queries to record and whether to report SQL bindings. Recorded queries are automatically included in error reports and can be accessed programmatically.

```php
// Queries are automatically recorded when recorders are enabled
// Access recorded queries in error reports

// In a service provider or bootstrap file
use SpatieLaravelIgnitionRecordersQueryRecorderQueryRecorder;

// Customize query recording
app(QueryRecorder::class)
    ->setMaxQueries(500) // Increase from default 200
    ->setReportBindings(true); // Include SQL bindings

// Example: Queries appear in error context
public function calculateReport()
{
    $users = User::where('active', true)->get(); // Query 1: SELECT * FROM users WHERE active = 1
    $orders = Order::whereIn('user_id', $users->pluck('id'))->get(); // Query 2: SELECT * FROM orders WHERE user_id IN (...)

    throw new Exception('Calculation failed'); // Error page shows both queries with bindings
}

// Access queries programmatically
$queries = app(QueryRecorder::class)->getQueries();
// [
//     ['query' => 'SELECT * FROM users WHERE active = ?', 'bindings' => [1], 'time' => 2.5],
//     ['query' => 'SELECT * FROM orders WHERE user_id IN (?, ?)', 'bindings' => [1, 2], 'time' => 5.3],
// ]
```

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

### Record and Access Variable Dumps in Laravel Ignition

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This snippet demonstrates how to automatically record variable dumps using the `dump()` function within Laravel Ignition. It shows how these dumps are captured by the `DumpRecorder` and how to access them programmatically. This is useful for debugging by inspecting variable states at specific points in your code.

```php
use Spatie\LaravelIgnition\Recorders\DumpRecorder\DumpRecorder;

// Dumps are automatically recorded when using dump()
public function debugFeature()
{
    $user = User::find(1);
    dump($user); // Captured by DumpRecorder

    $permissions = $user->permissions()->get();
    dump($permissions); // Also captured

    $config = config('app');
    dump($config); // Also captured

    throw new Exception('Debug point reached');
    // Error page shows all three dumps with file locations
}

// Access recorded dumps
$dumps = app(DumpRecorder::class)->getDumps();
// [
//     ['html' => '<pre>User {#123 ...}</pre>', 'file' => '/app/Controller.php', 'line' => 42],
//     ['html' => '<pre>Collection {#456 ...}</pre>', 'file' => '/app/Controller.php', 'line' => 45],
//     ['html' => '<pre>array:50 [...]]</pre>', 'file' => '/app/Controller.php', 'line' => 48],
// ]
```

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

### Update Configuration Endpoint using cURL

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This cURL command demonstrates how to update Laravel Ignition's configuration settings via its API. It uses a POST request to the `/_ignition/update-config` endpoint with a JSON payload specifying desired settings like theme and editor preferences. This allows for runtime modification of Ignition's appearance and behavior.

```bash
# Update Ignition settings (theme, editor, etc.)
curl -X POST http://localhost/_ignition/update-config \
  -H "Content-Type: application/json" \
  -d '{
    "theme": "dark",
    "editor": "vscode"
  }'
```

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

### Configure Log Recorder in PHP

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Enables and customizes automatic logging of messages within Laravel Ignition. The LogRecorder can be configured to set the maximum number of log messages to capture. Logged messages, including their level and context, are automatically displayed in error reports and can be accessed programmatically.

```php
use IlluminateSupportFacadesLog;
use SpatieLaravelIgnitionRecordersLogRecorderLogRecorder;

// Customize log recording limits
app(LogRecorder::class)->setMaxLogs(300); // Default is 200

// Logs are automatically captured and shown in error context
public function processOrder(Order $order)
{
    Log::info('Starting order processing', ['order_id' => $order->id]);

    Log::debug('Validating inventory', [
        'product_id' => $order->product_id,
        'requested_quantity' => $order->quantity,
    ]);

    if ($order->quantity > $stock) {
        Log::warning('Insufficient stock', [
            'available' => $stock,
            'requested' => $order->quantity,
        ]);
    }

    throw new Exception('Order processing failed');
    // Error page displays all log messages in chronological order
}

// Access recorded logs programmatically
$logs = app(LogRecorder::class)->getLogMessages();
// [
//     ['level' => 'info', 'message' => 'Starting order processing', 'context' => [...]],
//     ['level' => 'debug', 'message' => 'Validating inventory', 'context' => [...]],
//     ['level' => 'warning', 'message' => 'Insufficient stock', 'context' => [...]],
// ]
```

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

### Add Custom Context to Flare Error Reports (PHP)

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This PHP code demonstrates how to use the Flare facade in Laravel Ignition to add custom context to error reports. You can add single key-value pairs or group multiple related pieces of information under a common key, providing more detailed insights into the application state when an error occurs.

```php
use Spatie\LaravelIgnition\Facades\Flare;

// Add single context value
Flare::context('user_role', 'admin');
Flare::context('subscription_plan', 'premium');
Flare::context('feature_flags', ['new_dashboard' => true]);

// Add grouped context
Flare::group('user_info', [
    'id' => auth()->id(),
    'email' => auth()->user()->email,
    'plan' => auth()->user()->subscription->plan,
    'registered_at' => auth()->user()->created_at,
]);

Flare::group('request_metadata', [
    'referer' => request()->headers->get('referer'),
    'user_agent' => request()->userAgent(),
    'ip' => request()->ip(),
]);
```

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

### Enhanced Debugging with ddd() in PHP

Source: https://context7.com/spatie/laravel-ignition/llms.txt

Replaces standard Laravel's dd() with Ignition's ddd() for a more visually appealing error page displaying dumped variables. Execution stops after the ddd() call. This function takes multiple variables as arguments. It's useful for inspecting complex data structures during development.

```php
// Standard Laravel dd() - plain output
dd($users, $orders);

// Ignition's ddd() - beautiful error page with dump data
ddd($users, $orders);

// In a controller action
public function debug(User $user)
{
    // Dump with full Ignition error page UI
    ddd([
        'user' => $user,
        'permissions' => $user->permissions,
        'last_login' => $user->last_login_at,
        'debug_info' => [
            'queries' => DB::getQueryLog(),
            'memory' => memory_get_usage(true),
        ],
    ]);
    // Execution stops here with beautiful dump display
}
```

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

### Record and Access Failed Job Information in Laravel Ignition

Source: https://context7.com/spatie/laravel-ignition/llms.txt

This section illustrates how Laravel Ignition's `JobRecorder` automatically captures details of failed jobs, including chained jobs. It shows how to customize the recording depth and how to access the recorded job information programmatically after a failure occurs. This is crucial for diagnosing issues within background job processing.

```php
use Spatie\LaravelIgnition\Recorders\JobRecorder\JobRecorder;

// Customize job recording depth
app(JobRecorder::class); // Default max_chained_job_reporting_depth is 5

// Job details are automatically captured on failure
class ProcessOrder implements ShouldQueue
{
    public function __construct(
        public Order $order,
        public bool $sendNotification = true
    ) {}

    public function handle()
    {
        // Process order logic
        throw new Exception('Job failed'); // Captures full job details
    }
}

// Chain of jobs is recorded
ProcessOrder::dispatch($order)
    ->chain([
        new SendOrderConfirmation($order),
        new UpdateInventory($order),
        new GenerateInvoice($order),
    ]);
// If any job fails, entire chain is visible in error report

// Access recorded job information
$job = app(JobRecorder::class)->getJob();
// [
//     'name' => 'App\Jobs\ProcessOrder',
//     'connection' => 'redis',
//     'queue' => 'default',
//     'data' => ['order' => [...], 'sendNotification' => true],
//     'chained' => [
//         ['name' => 'App\Jobs\SendOrderConfirmation', 'data' => [...]],
//         ['name' => 'App\Jobs\UpdateInventory', 'data' => [...]],
//     ],
// ]
```
Tokens:
Raw