Laravel Horizon

https://github.com/laravel/horizon
Admin
Laravel Horizon provides a beautiful dashboard and code-driven configuration for Laravel powered...
Tokens:31,541
Snippets:433
Trust Score:9.7
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Monitoring Creation Response

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Example JSON response body returned after successfully starting tag monitoring.

```json
{
  "tag": "user:42",
  "monitored_jobs": 0,
  "created_at": 1693497600
}
```

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

### Retrieve environments from ProvisioningPlan

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Use this to get a list of all environment names defined in the plan.

```php
$plan = ProvisioningPlan::get('master');
$envs = $plan->environments();
// Returns: ['production', 'staging', 'local']
```

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

### Complete Horizon Configuration Structure

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

A comprehensive example of the horizon.php configuration file, including environment-specific settings and supervisor definitions.

```php
<?php

return [
    'name' => env('HORIZON_NAME', 'Horizon'),
    'domain' => env('HORIZON_DOMAIN'),
    'path' => env('HORIZON_PATH', 'horizon'),
    'use' => 'default',
    'prefix' => env('HORIZON_PREFIX', 'horizon:'),
    'middleware' => ['web'],

    'waits' => [
        'redis:default' => 60,
        'redis:high' => 30,
    ],

    'trim' => [
        'recent' => 60,
        'pending' => 60,
        'completed' => 60,
        'recent_failed' => 10080,
        'failed' => 10080,
        'monitored' => 10080,
    ],

    'silenced' => [
        // App\Jobs\HealthCheck::class,
    ],

    'silenced_tags' => [
        // 'health-check',
    ],

    'metrics' => [
        'trim_snapshots' => [
            'job' => 24,
            'queue' => 24,
        ],
    ],

    'fast_termination' => false,
    'memory_limit' => 64,

    'defaults' => [
        'supervisor-1' => [
            'connection' => 'redis',
            'queue' => ['default'],
            'balance' => 'auto',
            'autoScalingStrategy' => 'time',
            'maxProcesses' => 1,
            'maxTime' => 0,
            'maxJobs' => 0,
            'memory' => 128,
            'tries' => 1,
            'timeout' => 60,
            'nice' => 0,
        ],
    ],

    'environments' => [
        'production' => [
            'supervisor-1' => [
                'maxProcesses' => 10,
            ],
        ],

        'local' => [
            'supervisor-1' => [
                'maxProcesses' => 3,
            ],
        ],
    ],

    'watch' => [
        'app',
        'bootstrap',
        'config/**/*.php',
        'database/**/*.php',
        'public/**/*.php',
        'resources/**/*.php',
        'routes',
        'composer.lock',
        'composer.json',
        '.env',
    ],
];
```

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

### POST /horizon/api/monitoring

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Starts monitoring a specific tag.

```APIDOC
## POST /horizon/api/monitoring

### Description
Start monitoring a tag.

### Method
POST

### Endpoint
/horizon/api/monitoring

### Parameters
#### Request Body
- **tag** (string) - Required - Tag to monitor

### Request Example
{
  "tag": "user:42"
}

### Response
#### Success Response (201)
- **tag** (string) - The tag name
- **monitored_jobs** (integer) - Number of jobs monitored
- **created_at** (integer) - Timestamp of creation
```

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

### Retrieve ProvisioningPlan via get()

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Load a provisioning plan instance directly from the Horizon configuration files using the master supervisor name.

```php
use Laravel\Horizon\ProvisioningPlan;

$plan = ProvisioningPlan::get('my-master');
// Automatically loads from config
```

```php
public static function get(string $master): static
```

```php
$plan = ProvisioningPlan::get('production-master');
// Loads from:
// - config('horizon.environments')
// - config('horizon.defaults')
```

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

### Queue Tagging Examples

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/Tags.md

Demonstrates how tags are applied across different queued operations like events, mailables, and notifications.

```php
// Queued event listener
Event::dispatch(new UserRegistered($user));  // Tags: ['user:123']

// Queued mailable
Mail::queue(new WelcomeEmail($user));  // Tags: ['user:123']

// Queued notification
$user->notify(new VerifyEmail());  // Tags: ['user:123']

// Queued job
dispatch(new ProcessFile($file));  // Tags: any from tags() method
```

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

### POST /api/monitoring

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Starts monitoring a specific tag.

```APIDOC
## POST /api/monitoring

### Description
Starts monitoring a specific tag within the Horizon system.

### Method
POST

### Endpoint
/api/monitoring
```

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

### Multi-Queue SupervisorOptions Setup

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/SupervisorOptions.md

Configures a supervisor to monitor multiple queues simultaneously with automatic load balancing enabled.

```php
$options = new SupervisorOptions(
    name: 'supervisor-1',
    connection: 'redis',
    queue: 'default,high,low',  // Multiple queues
    balance: 'auto',  // Distribute workers across queues
    maxProcesses: 8,
);
```

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

### Start Monitoring a Tag

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Registers a new tag to be monitored by Horizon.

```http
POST /horizon/api/monitoring
Content-Type: application/json

{
  "tag": "user:42"
}
```

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

### GET /horizon/api/workload

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Get the current workload distribution across supervisors.

```APIDOC
## GET /horizon/api/workload

### Description
Get the current workload distribution across supervisors.

### Method
GET

### Endpoint
/horizon/api/workload

### Response
#### Success Response (200)
- **processes** (object) - Process count per supervisor per queue
- **status** (string) - Overall status

#### Response Example
{
  "processes": {
    "supervisor-1": {
      "redis:default": 4,
      "redis:high": 2
    },
    "supervisor-2": {
      "redis:default": 2,
      "redis:low": 4
    }
  },
  "status": "running"
}
```

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

### Adjusting Job Timeout

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/errors.md

Example of increasing the timeout configuration value.

```php
// Increase timeout if job legitimately needs more time
'timeout' => 120,
```

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

### GET /horizon/api/monitoring

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves a list of all currently monitored tags.

```APIDOC
## GET /horizon/api/monitoring

### Description
Get all monitored tags.

### Method
GET

### Endpoint
/horizon/api/monitoring

### Response
#### Success Response (200)
- **tag** (string) - The tag name
- **monitored_jobs** (integer) - Number of jobs monitored
- **created_at** (integer) - Timestamp of creation

#### Response Example
[
  {
    "tag": "user:42",
    "monitored_jobs": 5,
    "created_at": 1693497600
  }
]
```

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

### commandQueue(): string

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/MasterSupervisor.md

Get the command queue name for this master supervisor.

```APIDOC
## commandQueue()

### Description
Get the command queue name for this master supervisor.

### Returns
- **string** - Queue name format: master:{$name}:commands

### Example
$queueName = $master->commandQueue();
```

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

### Get Command Name

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/JobPayload.md

Retrieve the command name from the job data.

```php
$name = $payload->commandName();
// For queued events/listeners, returns command name
```

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

### GET /horizon/api/monitoring/{tag}

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves paginated jobs for a specific monitored tag.

```APIDOC
## GET /horizon/api/monitoring/{tag}

### Description
Get jobs for a monitored tag (paginated).

### Method
GET

### Endpoint
/horizon/api/monitoring/{tag}

### Parameters
#### Path Parameters
- **tag** (string) - Required - The monitored tag (URL encoded)

#### Query Parameters
- **after_index** (string) - Optional - Pagination cursor
```

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

### Job Exception Details JSON

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/errors.md

Example of the JSON structure stored when a job execution throws an unhandled exception.

```json
{
  "id": "job-uuid",
  "exception": "RuntimeException: Something went wrong",
  "context": {
    "file": "app/Jobs/MyJob.php",
    "line": 42
  },
  "failed_at": 1693497600
}
```

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

### Retrieve Basename

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/MasterSupervisor.md

Get the slugified hostname or custom basename for the machine's master supervisors.

```php
$base = MasterSupervisor::basename();
// Returns: 'my-production-server'
```

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

### Instantiate ProvisioningPlan

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Create a new instance of the ProvisioningPlan class by providing the master supervisor name, the raw plan array, and optional default settings.

```php
public function __construct(
    string $master,
    array $plan,
    array $defaults = []
): void
```

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

### Initialize MasterSupervisor

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/MasterSupervisor.md

Instantiate a new MasterSupervisor with an optional environment string.

```php
use Laravel\Horizon\MasterSupervisor;

$master = new MasterSupervisor('production');
```

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

### GET /horizon/api/jobs/failed

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Get failed jobs.

```APIDOC
## GET /horizon/api/jobs/failed

### Description
Get failed jobs.

### Method
GET

### Endpoint
/horizon/api/jobs/failed

### Parameters
#### Query Parameters
- **after_index** (string) - Optional - Pagination cursor

### Response
#### Success Response (200)
- **exception** (string) - Exception message
- **context** (object) - Exception context
- **failed_at** (int) - When it failed (timestamp)
- **retried_by** (string|null) - ID of retry job if retried
```

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

### Configure and Execute AutoScaler

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/AutoScaler.md

Demonstrates initializing a Supervisor with auto-scaling options and triggering the scaling process via the AutoScaler service.

```php
use Laravel\Horizon\AutoScaler;
use Laravel\Horizon\Supervisor;
use Laravel\Horizon\SupervisorOptions;

// Set up supervisor with auto-scaling
$options = new SupervisorOptions(
    name: 'supervisor-1',
    connection: 'redis',
    queue: 'default,high,low',
    balance: 'auto',  // Enable auto-scaling
    maxProcesses: 10,
    minProcesses: 2,
    balanceCooldown: 3,
    balanceMaxShift: 2,
    autoScalingStrategy: 'time',
);

$supervisor = new Supervisor($options);

// Scale the supervisor
$scaler = app(AutoScaler::class);
$scaler->scale($supervisor);

// Later, check new process counts
foreach ($supervisor->processPools as $pool) {
    echo "Queue: " . $pool->queue() . ", Processes: " . $pool->size() . "\n";
}
```

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

### GET /horizon/api/masters

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Get information on all master supervisors.

```APIDOC
## GET /horizon/api/masters

### Description
Get information on all master supervisors.

### Method
GET

### Endpoint
/horizon/api/masters

### Response
#### Success Response (200)
- **name** (string) - Master supervisor name
- **status** (string) - 'running' or 'paused'
- **supervisors** (array) - List of managed supervisor names
- **updated_at** (int) - Last update timestamp
- **memory** (int) - Memory usage in MB
- **processes** (object) - Process count per queue

#### Response Example
[
  {
    "name": "my-server-a1b2",
    "status": "running",
    "supervisors": ["supervisor-1", "supervisor-2"],
    "updated_at": 1693497600,
    "memory": 45,
    "processes": {
      "redis:default": 4
    }
  }
]
```

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

### GET /horizon/api/jobs/pending

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Get pending (not yet reserved) jobs.

```APIDOC
## GET /horizon/api/jobs/pending

### Description
Get pending (not yet reserved) jobs.

### Method
GET

### Endpoint
/horizon/api/jobs/pending

### Parameters
#### Query Parameters
- **after_index** (string) - Optional - Pagination cursor

### Response
#### Success Response (200)
- **id** (string) - Job UUID
- **name** (string) - Job class name
- **queue** (string) - Queue name
- **connection** (string) - Connection name
- **status** (string) - Job status
- **payload** (string) - JSON payload
- **tags** (array) - Job tags
- **created_at** (int) - Unix timestamp
```

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

### GET /api/batches

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves a list of all job batches.

```APIDOC
## GET /api/batches

### Description
Get all job batches.

### Method
GET

### Endpoint
/horizon/api/batches

### Parameters
#### Query Parameters
- **after_index** (string) - Optional - The index to start retrieving batches from.

### Response
#### Success Response (200)
- **id** (string) - The batch UUID.
- **name** (string) - The name of the batch.
- **total_jobs** (integer) - Total number of jobs in the batch.
- **pending_jobs** (integer) - Number of pending jobs.
- **failed_jobs** (integer) - Number of failed jobs.
- **created_at** (integer) - Timestamp of creation.
- **finished_at** (integer|null) - Timestamp of completion.
```

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

### GET /horizon/api/metrics/queues

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves metrics for all measured queues.

```APIDOC
## GET /horizon/api/metrics/queues

### Description
Get metrics for all measured queues.

### Method
GET

### Endpoint
/horizon/api/metrics/queues

### Response
#### Success Response (200)
- **name** (string) - Queue in format connection:name
- **throughput** (int) - Jobs processed since snapshot
- **runtime** (float) - Average runtime in ms
- **processed** (int) - Total processed in period

#### Response Example
[
  {
    "name": "redis:default",
    "throughput": 1200,
    "runtime": 850,
    "processed": 50000
  }
]
```

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

### Deploy a provisioning plan

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Triggers the deployment process for a specific environment, queuing supervisor commands.

```php
$plan = ProvisioningPlan::get('my-master');
$plan->deploy('production');
// Queues supervisor startup commands
```

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

### GET /horizon/api/metrics/jobs

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves metrics for all measured jobs.

```APIDOC
## GET /horizon/api/metrics/jobs

### Description
Get metrics for all measured jobs.

### Method
GET

### Endpoint
/horizon/api/metrics/jobs

### Response
#### Success Response (200)
- **name** (string) - Job class name
- **throughput** (int) - Jobs processed since last snapshot
- **runtime** (float) - Average runtime in milliseconds
- **processed** (int) - Total processed in period

#### Response Example
[
  {
    "name": "App\\Jobs\\ProcessOrder",
    "throughput": 450,
    "runtime": 1250,
    "processed": 12500
  }
]
```

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

### Using JobPayload

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/JobPayload.md

Shows how to create a JobPayload from JSON, prepare it with a job instance, and access or modify its fields.

```php
use Laravel\Horizon\JobPayload;

// Create from JSON string
$json = json_encode([
    'uuid' => 'abc-123',
    'displayName' => 'ProcessOrder',
    'data' => [...],
    'tags' => ['order:456'],
]);

$payload = new JobPayload($json);

// Prepare with job instance
class ProcessOrder implements ShouldQueue {
    public function tags() {
        return ['background'];
    }
}

$job = new ProcessOrder();
$payload->prepare($job);

// Access fields
echo $payload->id();              // 'abc-123'
echo $payload->displayName();     // 'ProcessOrder'
print_r($payload->tags());        // ['background', 'order:456']
echo $payload['uuid'];            // 'abc-123' (ArrayAccess)

// Modify fields
$payload->set(['custom' => 'data']);
unset($payload['sensitive']);
```

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

### Instantiate WaitTimeCalculator

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/WaitTimeCalculator.md

Initialize the calculator using the required queue, supervisor, and metrics repositories.

```php
use Laravel\Horizon\WaitTimeCalculator;

$calculator = new WaitTimeCalculator(
    app('queue'),
    app(SupervisorRepository::class),
    app(MetricsRepository::class)
);
```

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

### GET /api/stats

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Retrieves the current dashboard statistics for Horizon.

```APIDOC
## GET /api/stats

### Description
Retrieves the current dashboard statistics for Horizon.

### Method
GET

### Endpoint
/api/stats
```

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

### Configure Horizon settings

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Define queue system behavior, supervisor configurations, and environment-specific overrides in the configuration file.

```php
// config/horizon.php - Minimal setup
return [
    'name' => 'My Queue System',
    'use' => 'default',
    'path' => 'horizon',
    
    'defaults' => [
        'supervisor-1' => [
            'connection' => 'redis',
            'queue' => 'default',
            'balance' => 'auto',
            'maxProcesses' => 1,
        ],
    ],

    'environments' => [
        'production' => [
            'supervisor-1' => [
                'maxProcesses' => 10,
            ],
        ],
    ],
];
```

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

### toSupervisorOptions()

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Converts the entire provisioning plan to an array of SupervisorOptions.

```APIDOC
## toSupervisorOptions()

### Description
Convert the entire provisioning plan to an array of SupervisorOptions.

### Signature
`public function toSupervisorOptions(): array`

### Returns
- **array** - Format: [environment => [supervisor => SupervisorOptions, ...], ...].
```

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

### Get Display Name

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/JobPayload.md

Retrieve the display name of the job.

```php
$display = $payload->displayName();
// Returns: 'SendEmail'
```

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

### deploy(string $environment)

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Deploys a provisioning plan to the current machine for a given environment.

```APIDOC
## deploy(string $environment)

### Description
Deploy a provisioning plan to the current machine for a given environment.

### Signature
`public function deploy(string $environment): void`

### Parameters
- **$environment** (string) - Required - Environment name to deploy
```

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

### GET /api/batches/{id}

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves the details of a specific job batch.

```APIDOC
## GET /api/batches/{id}

### Description
Get batch details.

### Method
GET

### Endpoint
/horizon/api/batches/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The UUID of the batch.

### Response
#### Success Response (200)
- **id** (string) - The batch UUID.
- **name** (string) - The name of the batch.
- **total_jobs** (integer) - Total number of jobs in the batch.
- **pending_jobs** (integer) - Number of pending jobs.
- **failed_jobs** (integer) - Number of failed jobs.
- **created_at** (integer) - Timestamp of creation.
- **finished_at** (integer|null) - Timestamp of completion.
- **jobs** (array) - List of jobs within the batch.
```

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

### GET /api/jobs/{status}

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Retrieves a list of jobs filtered by their status.

```APIDOC
## GET /api/jobs/{status}

### Description
Retrieves a list of jobs based on the provided status (e.g., pending, completed, failed, silenced).

### Method
GET

### Endpoint
/api/jobs/{status}

### Parameters
#### Path Parameters
- **status** (string) - Required - The status of the jobs to retrieve (pending, completed, failed, silenced).
```

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

### Convert Plan to Configuration Array

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Retrieve all supervisor options as an array and convert individual configurations to JSON format.

```php
$plan = ProvisioningPlan::get('master');
$allOptions = $plan->toSupervisorOptions();

foreach ($allOptions as $env => $supervisors) {
    foreach ($supervisors as $name => $options) {
        // Work with each SupervisorOptions
        $json = $options->toJson();
    }
}
```

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

### GET /horizon/api/metrics/queues/{id}

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves detailed metrics for a specific queue.

```APIDOC
## GET /horizon/api/metrics/queues/{id}

### Description
Get detailed metrics for a specific queue.

### Method
GET

### Endpoint
/horizon/api/metrics/queues/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The queue identifier in format connection:name
```

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

### Convert plan to SupervisorOptions array

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Retrieves all supervisor configurations mapped by environment and supervisor name.

```php
$allOptions = $plan->toSupervisorOptions();
// Returns: [
//   'production' => [
//     'supervisor-1' => SupervisorOptions { ... },
//     'supervisor-2' => SupervisorOptions { ... },
//   ],
//   'local' => [
//     'supervisor-1' => SupervisorOptions { ... },
//   ],
// ]
```

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

### Calculate wait time for multiple queues

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/WaitTimeCalculator.md

Demonstrates how to configure a supervisor for multiple queues and calculate the aggregated wait time.

```php
// Supervisor watching multiple queues
$supervisor->options->queue = 'default,high,low';

// Calculator sums wait time across all three
$wait = $calculator->calculateFor('redis:default,high,low');
```

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

### Retrieve Job Tags

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/JobPayload.md

Get an array of tags associated with the job.

```php
$tags = $payload->tags();
// Returns: ['user:42', 'order:123']
```

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

### Instantiate SupervisorOptions

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/SupervisorOptions.md

Create a new instance of SupervisorOptions with custom configuration for a specific supervisor.

```php
use Laravel\Horizon\SupervisorOptions;

$options = new SupervisorOptions(
    name: 'supervisor-1',
    connection: 'redis',
    queue: 'default,high',
    maxProcesses: 5,
    minProcesses: 2,
    balance: 'auto',
    autoScalingStrategy: 'time',
    timeout: 60,
    memory: 256
);
```

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

### environments()

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Retrieves all defined environments in the provisioning plan.

```APIDOC
## environments()

### Description
Get all defined environments in the provisioning plan.

### Signature
`public function environments(): array`

### Returns
- **array** - List of environment names as keys.
```

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

### Initialize AutoScaler

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/AutoScaler.md

Instantiate the AutoScaler using the queue manager and metrics repository from the application container.

```php
use Laravel\Horizon\AutoScaler;
use Illuminate\Queue\QueueManager;
use Laravel\Horizon\Contracts\MetricsRepository;

$scaler = new AutoScaler(
    app(QueueManager::class),
    app(MetricsRepository::class)
);
```

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

### GET /api/monitoring/{tag}

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Retrieves jobs associated with a specific monitored tag.

```APIDOC
## GET /api/monitoring/{tag}

### Description
Retrieves a list of jobs associated with the specified monitored tag.

### Method
GET

### Endpoint
/api/monitoring/{tag}

### Parameters
#### Path Parameters
- **tag** (string) - Required - The tag to retrieve jobs for.
```

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

### ProvisioningPlan::get

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Loads the current provisioning plan from the Horizon configuration based on the provided master supervisor name.

```APIDOC
## ProvisioningPlan::get

### Description
Loads the current provisioning plan from Horizon configuration.

### Method
Static Method

### Parameters
- **$master** (string) - Required - Master supervisor name

### Returns
- **static** - ProvisioningPlan instance with config loaded.

### Example
```php
use Laravel\Horizon\ProvisioningPlan;

$plan = ProvisioningPlan::get('production-master');
```
```

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

### Check Supervisor Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Iterate through environments to inspect specific supervisor options like process counts and memory limits.

```php
$plan = ProvisioningPlan::get('master');

foreach ($plan->environments() as $env) {
    $options = $plan->optionsFor($env, 'supervisor-1');
    
    if ($options) {
        echo "Environment: $env\n";
        echo "Max Processes: " . $options->maxProcesses . "\n";
        echo "Memory: " . $options->memory . " MB\n";
    }
}
```

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

### Deploy Production Supervisors

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Use the deploy method to apply supervisor configurations for a specific environment.

```php
use Laravel\Horizon\ProvisioningPlan;

$plan = ProvisioningPlan::get('production-master');

if ($plan->hasEnvironment('production')) {
    $plan->deploy('production');
    // All supervisors for production are now deployed
}
```

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

### GET /horizon/api/metrics/jobs/{id}

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves detailed historical metrics for a specific job.

```APIDOC
## GET /horizon/api/metrics/jobs/{id}

### Description
Get detailed metrics for a specific job.

### Method
GET

### Endpoint
/horizon/api/metrics/jobs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The job class name

### Response
#### Success Response (200)
- **name** (string) - Job class name
- **snapshots** (array) - Historical metrics snapshots
- **snapshots[].at** (int) - Timestamp of snapshot
- **snapshots[].throughput** (int) - Jobs in this period
- **snapshots[].runtime** (float) - Avg runtime this period (ms)

#### Response Example
{
  "name": "App\\Jobs\\ProcessOrder",
  "snapshots": [
    {
      "at": 1693497600,
      "throughput": 50,
      "runtime": 1250
    }
  ]
}
```

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

### GET /api/jobs/failed/{id}

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/errors.md

Retrieves the details of a specific failed job by its unique identifier.

```APIDOC
## GET /api/jobs/failed/{id}

### Description
Retrieves the details of a failed job, including the exception message, file context, and failure timestamp.

### Method
GET

### Endpoint
/api/jobs/failed/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the failed job.

### Response
#### Success Response (200)
- **id** (string) - The job UUID
- **exception** (string) - The exception message
- **context** (object) - File and line information
- **failed_at** (integer) - Unix timestamp of failure
```

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

### Initialize JobPayload

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/JobPayload.md

Create a new instance by passing the raw JSON string from the queue.

```php
use Laravel\Horizon\JobPayload;

$json = '{"uuid":"abc-123","data":{"commandName":"SendEmail"},"tags":["user:42"]}';
$payload = new JobPayload($json);
```

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

### Monitored Tags Response

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Example JSON response body for the monitoring list endpoint.

```json
[
  {
    "tag": "user:42",
    "monitored_jobs": 5,
    "created_at": 1693497600
  }
]
```

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

### Publish Horizon Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

Command to generate the config/horizon.php file for customization.

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

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

### Get Jobs for Monitored Tag

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves a paginated list of jobs associated with a specific tag.

```http
GET /horizon/api/monitoring/user:42?after_index={afterIndex}
```

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

### Configure Production Deployment

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Defines supervisor settings within the environments configuration array for production queue management.

```php
'environments' => [
    'production' => [
        'supervisor-1' => [
            'connection' => 'redis',
            'queue' => ['default', 'high'],
            'balance' => 'auto',
            'autoScalingStrategy' => 'time',
            'maxProcesses' => 20,
            'minProcesses' => 5,
            'maxTime' => 3600,          // 1 hour max worker lifetime
            'maxJobs' => 1000,          // Restart after 1000 jobs
            'memory' => 256,            // 256 MB per worker
            'timeout' => 90,            // 90 seconds per job
            'balanceCooldown' => 3,
            'balanceMaxShift' => 2,
        ],
    ],
],
```

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

### optionsFor(string $environment, string $supervisor)

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Retrieves the SupervisorOptions for a specific environment and supervisor.

```APIDOC
## optionsFor(string $environment, string $supervisor)

### Description
Get the SupervisorOptions for a specific environment and supervisor.

### Signature
`public function optionsFor(string $environment, string $supervisor): SupervisorOptions|null`

### Parameters
- **$environment** (string) - Required - Environment name
- **$supervisor** (string) - Required - Supervisor name (e.g., 'supervisor-1')

### Returns
- **SupervisorOptions|null** - Options if found, null otherwise.
```

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

### GET /horizon/api/stats

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/WaitTimeCalculator.md

Retrieves dashboard statistics, including the current wait times for configured queues.

```APIDOC
## GET /horizon/api/stats

### Description
Retrieves dashboard statistics, including the current wait times for configured queues.

### Method
GET

### Endpoint
/horizon/api/stats

### Response
#### Success Response (200)
- **wait** (array) - A list of objects containing queue names and their respective wait times in seconds.

#### Response Example
{
  "wait": [
    { "queue": "redis:default", "time": 45 }
  ]
}
```

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

### Retrieve SupervisorOptions for a specific supervisor

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Fetches configuration options for a given environment and supervisor name.

```php
$options = $plan->optionsFor('production', 'supervisor-1');
if ($options) {
    echo "Max processes: " . $options->maxProcesses;
}
```

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

### Get Original Job ID

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/JobPayload.md

Retrieve the ID of the original job if the current job is a retry.

```php
if ($payload->isRetry()) {
    $original = $payload->retryOf();
    echo "This is a retry of: $original";
}
```

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

### Configure Horizon File Watcher

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

Define the directories and files monitored by the horizon:listen command to trigger automatic restarts.

```php
'watch' => [
    'app',
    'bootstrap',
    'config/**/*.php',
    'database/**/*.php',
    'public/**/*.php',
    'resources/**/*.php',
    'routes',
    'composer.lock',
    'composer.json',
    '.env',
],
```

```php
'watch' => [
    'app',
    'config',
    'routes',
    'composer.lock',
],
```

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

### Get target objects for tag determination

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/Tags.md

Identifies the underlying target object from a wrapper like BroadcastEvent or CallQueuedListener.

```php
$event = new UserCreated($user);
$targets = Tags::targetsFor(new BroadcastEvent($event));
// Returns: [UserCreated instance]
```

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

### restart(): void

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/MasterSupervisor.md

Restart the master supervisor.

```APIDOC
## restart()

### Description
Restart the master supervisor. Restarts the supervisor process; workers are terminated gracefully.

### Example
$master->restart();
```

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

### Check for environment existence

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

Verify if a specific environment is defined within the provisioning plan.

```php
if ($plan->hasEnvironment('production')) {
    // Deploy production config
}
```

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

### Manage Horizon via CLI

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Control the Horizon process and worker states using Artisan commands.

```bash
# Start Horizon
php artisan horizon

# In another terminal
php artisan horizon:pause        # Pause workers
php artisan horizon:continue     # Resume workers
php artisan horizon:terminate    # Stop Horizon
```

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

### Development SupervisorOptions Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/SupervisorOptions.md

Configures a supervisor for development environments with minimal process requirements and load balancing disabled.

```php
$development = new SupervisorOptions(
    name: 'supervisor-1',
    connection: 'redis',
    queue: 'default',
    maxProcesses: 3,
    minProcesses: 1,
    balance: 'off',
    memory: 128,
);
```

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

### Calculate Wait Time for a Specific Queue

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/WaitTimeCalculator.md

Get the estimated clearance time for a single queue identified by the {connection}:{queue} format.

```php
$seconds = $calculator->calculateFor('redis:default');
echo "Wait time: " . round($seconds) . " seconds";
```

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

### Bind Custom Repository Implementations

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Use the service provider to bind custom implementations to Horizon's service contracts.

```php
$this->app->bind(JobRepository::class, CustomJobRepository::class);
```

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

### GET /api/stats

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Retrieves key performance statistics for the Horizon dashboard, including job counts, process status, and queue wait times.

```APIDOC
## GET /horizon/api/stats

### Description
Get key performance statistics for the dashboard.

### Method
GET

### Endpoint
/horizon/api/stats

### Response
#### Success Response (200)
- **failedJobs** (int) - Count of failed jobs in trim period
- **jobsPerMinute** (int) - Jobs processed per minute
- **pausedMasters** (int) - Number of paused masters
- **periods.failedJobs** (int) - Failed job retention (minutes)
- **periods.recentJobs** (int) - Recent job retention (minutes)
- **processes** (int) - Total worker processes
- **queueWithMaxRuntime** (string) - Queue with longest avg runtime
- **queueWithMaxThroughput** (string) - Queue with most throughput
- **recentJobs** (int) - Count of recent jobs
- **status** (string) - Overall status: 'running', 'paused', 'inactive'
- **wait** (array) - Queue wait times

#### Response Example
{
  "failedJobs": 5,
  "jobsPerMinute": 120,
  "pausedMasters": 0,
  "periods": {
    "failedJobs": 10080,
    "recentJobs": 60
  },
  "processes": 8,
  "queueWithMaxRuntime": "redis:default",
  "queueWithMaxThroughput": "redis:high",
  "recentJobs": 1250,
  "status": "running",
  "wait": [
    {
      "queue": "redis:default",
      "time": 45
    }
  ]
}
```

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

### Production SupervisorOptions Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/SupervisorOptions.md

Configures a supervisor for production environments with higher process limits and automatic load balancing.

```php
$production = new SupervisorOptions(
    name: 'supervisor-1',
    connection: 'redis',
    queue: 'default',
    maxProcesses: 10,
    minProcesses: 3,
    balance: 'auto',
    timeout: 60,
    memory: 256,
    maxTime: 3600,  // 1 hour
);
```

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

### Define Horizon Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/ProvisioningPlan.md

The provisioning plan relies on the structure defined in config/horizon.php, which specifies defaults and environment-specific overrides for supervisors.

```php
// config/horizon.php
return [
    'defaults' => [
        'supervisor-1' => [
            'connection' => 'redis',
            'queue' => ['default'],
            'balance' => 'auto',
            'maxProcesses' => 1,
            'maxTime' => 0,
            'maxJobs' => 0,
            'memory' => 128,
            'tries' => 1,
            'timeout' => 60,
            'nice' => 0,
        ],
    ],

    'environments' => [
        'production' => [
            'supervisor-1' => [
                'maxProcesses' => 10,
                'memory' => 256,
                'timeout' => 90,
            ],
        ],

        'local' => [
            'supervisor-1' => [
                'maxProcesses' => 3,
            ],
        ],
    ],
];
```

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

### Horizon Documentation File Map

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/INDEX.md

A directory structure overview of the Horizon documentation repository.

```text
/output/
├── README.md                      (Main overview & quick start)
├── types.md                       (All contracts, interfaces, events)
├── configuration.md               (All config options)
├── endpoints.md                   (REST API reference)
├── errors.md                      (Exceptions & troubleshooting)
├── INDEX.md                       (This file)
│
└── /api-reference/
    ├── Horizon.md                 (Main façade class)
    ├── SupervisorOptions.md       (Supervisor configuration)
    ├── MasterSupervisor.md        (Master process management)
    ├── ProvisioningPlan.md        (Configuration deployment)
    ├── JobPayload.md              (Job payload wrapper)
    ├── Tags.md                    (Job tagging system)
    ├── AutoScaler.md              (Auto-scaling logic)
    └── WaitTimeCalculator.md      (Queue wait calculation)
```

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

### Configure Auto-scaling in horizon.php

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/AutoScaler.md

Define auto-scaling parameters such as strategy, process limits, and cooldowns within the Horizon configuration file.

```php
// config/horizon.php
return [
    'defaults' => [
        'supervisor-1' => [
            'connection' => 'redis',
            'queue' => 'default',
            'balance' => 'auto',  // Enable auto-scaling
            'autoScalingStrategy' => 'time',  // or 'size'
            'maxProcesses' => 10,
            'minProcesses' => 2,
            'balanceCooldown' => 3,
            'balanceMaxShift' => 1,
        ],
    ],

    'environments' => [
        'production' => [
            'supervisor-1' => [
                // Override defaults as needed
                'maxProcesses' => 20,
                'balanceMaxShift' => 2,
            ],
        ],
    ],
];
```

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

### Configure Horizon Environment Variables

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Set these variables in your .env file to define Horizon's behavior and Redis connection details.

```bash
HORIZON_NAME=Production Queues
HORIZON_DOMAIN=queue.example.com
HORIZON_PATH=horizon
HORIZON_PREFIX=myapp_horizon:
HORIZON_USE=default

# Redis connection
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
REDIS_PASSWORD=
REDIS_DB=0
```

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

### Defining Job Tags

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/JobPayload.md

Demonstrates how to implement the tags method and utilize model properties for automatic tag extraction.

```php
class OrderProcessor implements ShouldQueue {
    public $order;
    
    public function __construct(Order $order) {
        $this->order = $order;  // Model property
    }
    
    public function tags() {
        return ['order-processing'];
    }
}

// Final tags: ['order-processing', 'App\Models\Order:123']
```

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

### Generate Supervisor Command

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/SupervisorOptions.md

Retrieves the command-line string required to launch the supervisor process.

```php
$cmd = $options->toSupervisorCommand();
// Returns: "artisan horizon:work --name=supervisor-1 --connection=redis ..."
```

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

### Supervisor Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/errors.md

Supervisor minProcesses must be set to a value greater than 0.

```php
'environments' => [
    'production' => [
        'supervisor-1' => [
            'minProcesses' => 0,  // Invalid
        ],
    ],
],
```

```php
'environments' => [
    'production' => [
        'supervisor-1' => [
            'minProcesses' => 1,  // Must be >= 1
        ],
    ],
],
```

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

### Configure Horizon Path

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

Sets the URI path for the Horizon dashboard.

```php
'path' => env('HORIZON_PATH', 'horizon'),
```

```php
'path' => 'admin/queue',  // Accessible at /admin/queue
```

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

### Configure Horizon authentication

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/endpoints.md

Middleware and callback configurations for securing Horizon endpoints.

```php
// Configured in HorizonServiceProvider
Route::middlewareGroup('horizon', [
    SentinelMiddleware::class . ':horizon',
    ...config('horizon.middleware', ['web']),
]);
```

```php
// In AppServiceProvider::boot()
Horizon::auth(function ($request) {
    return $request->user() && $request->user()->isAdmin();
});
```

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

### Configure Middleware

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

Defines the middleware stack applied to all Horizon routes.

```php
'middleware' => ['web'],
```

```php
'middleware' => ['web', 'auth', 'admin'],
```

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

### Horizon::use

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/Horizon.md

Configures the Redis database connection used for storing Horizon metadata.

```APIDOC
## Horizon::use

### Description
Configure the Redis database connection that will store Horizon metadata.

### Signature
`public static function use(string $connection): void`

### Parameters
- **$connection** (string) - Required - Name of the Redis connection to use (from database.redis config)

### Exceptions
- **Exception** - If the specified Redis connection is not configured
```

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

### Define Environment-Specific Overrides

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

Overrides default supervisor settings based on the current APP_ENV. Non-specified options fall back to the values defined in defaults.

```php
'environments' => [
    'production' => [
        'supervisor-1' => [
            'maxProcesses' => 10,
            'balanceMaxShift' => 1,
            'balanceCooldown' => 3,
        ],
    ],

    'local' => [
        'supervisor-1' => [
            'maxProcesses' => 3,
        ],
    ],
],
```

```php
'environments' => [
    'production' => [
        'supervisor-1' => [
            'maxProcesses' => 20,
            'maxTime' => 3600,     // 1 hour
            'memory' => 512,
            'timeout' => 120,
        ],
    ],
    
    'staging' => [
        'supervisor-1' => [
            'maxProcesses' => 8,
            'memory' => 256,
        ],
    ],
    
    'local' => [
        'supervisor-1' => [
            'maxProcesses' => 2,
            'memory' => 128,
        ],
    ],
],
```

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

### Create from Array

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/SupervisorOptions.md

Instantiates a new SupervisorOptions object from an associative array.

```php
$config = [
    'name' => 'supervisor-1',
    'connection' => 'redis',
    'maxProcesses' => 5,
    'queue' => 'default',
];

$options = SupervisorOptions::fromArray($config);
```

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

### Listen for Horizon events

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Hook into the Horizon event system to handle job lifecycle or supervisor events.

```php
Event::listen(JobFailed::class, function ($event) {
    // Handle job failure
});
```

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

### loop(): void

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/MasterSupervisor.md

Perform a single work cycle (typically run in a loop).

```APIDOC
## loop()

### Description
Perform a single work cycle (typically run in a loop). Checks for work on supervisors, monitors memory usage, handles signals, and fires MasterSupervisorLooped event.

### Example
while ($master->working) {
    $master->loop();
}
```

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

### Configure Redis Connection for Horizon

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

Define the Redis connection settings in config/database.php and specify the connection name in config/horizon.php.

```php
'redis' => [
    'default' => [
        'driver' => 'redis',
        'connection' => env('REDIS_HOST', '127.0.0.1'),
        'port' => env('REDIS_PORT', 6379),
        'database' => 0,
    ],
    
    'horizon' => [
        'driver' => 'redis',
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'port' => env('REDIS_PORT', 6379),
        'database' => 1,  // Separate database for Horizon
    ],
],
```

```php
// config/horizon.php
'use' => 'horizon',
```

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

### Scale Supervisor Processes

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/AutoScaler.md

Configure supervisor options and trigger the scaling process to adjust worker counts based on queue depth.

```php
$supervisor->options->balance = 'auto';
$supervisor->options->maxProcesses = 10;
$supervisor->options->minProcesses = 2;

$scaler->scale($supervisor);
// Workers are automatically adjusted based on queue depth
```

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

### Configure Memory Limits

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/errors.md

Define memory limits for individual workers and the master supervisor process.

```php
// Worker memory limit
'memory' => 256,  // MB per worker

// Master supervisor memory
'memory_limit' => 64,  // MB total
```

```php
'memory' => 512,           // More per worker
'memory_limit' => 128,     // More for master
```

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

### Configure Horizon Memory Limit

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/configuration.md

Sets the maximum memory in MB for the Horizon master supervisor. Exceeding this limit triggers a restart and a MasterSupervisorOutOfMemory event.

```php
'memory_limit' => 64,
```

```php
'memory_limit' => 128,  // 128 MB before restart
```

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

### Memory Limit Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/errors.md

The memory_limit configuration must be an integer representing megabytes.

```php
'memory_limit' => 'invalid',  // Should be integer
```

```php
'memory_limit' => 64,  // Must be integer (MB)
```

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

### Implement job tagging

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/README.md

Add custom tags to queueable jobs to enable filtering and monitoring in the dashboard.

```php
class SendEmail implements ShouldQueue {
    public function tags() {
        return ['email', 'user:42'];
    }
}
```

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

### continue(): void

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/MasterSupervisor.md

Resume processing after being paused.

```APIDOC
## continue()

### Description
Resume processing after being paused. Sets $working to true; workers resume accepting new jobs.

### Example
$master->continue();
```

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

### Continue Master Supervisor

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/MasterSupervisor.md

Resumes processing by setting the working state to true.

```php
$master->continue();
```

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

### Update Queue Configuration

Source: https://github.com/laravel/horizon/blob/5.x/_autodocs/api-reference/SupervisorOptions.md

Creates a new instance with a modified queue name.

```php
$defaultOptions = new SupervisorOptions('sup-1', 'redis');
$highOptions = $defaultOptions->withQueue('high');
// $highOptions->queue === 'high'
```
Tokens:
Raw