​

Instance queue

The Gateway reports the queue of an Instance that runs Laravel Horizon. The report shows the state of Horizon, the load of each queue, and the newest pending, completed, or failed jobs. Processes and schedules describes the Process that runs Horizon.

​

Read the queue

GET /api/v1/instances/{instance}/queue returns one report. state selects the job list: pending, completed, or failed, and the default is pending. limit sets the number of jobs from 1 through 50, and the default is 50. The web app shows this report on the Instance page. The CLI and the PHP SDK have no command for it.

​

Know when a queue is available

The Gateway reports a queue when the Instance owns a systemd Process whose command is <php> artisan horizon, and the application has Horizon installed. An Instance without that Process answers available: false without a remote call. An Instance without Horizon installed also answers available: false. A Docker Process does not count, because the Gateway cannot run PHP in its checkout the way that Process does.

​

Know how the Gateway reads it

The Gateway opens an SSH session to the Node and runs one fixed PHP script in the checkout. It runs as the user of the Horizon Process, with the PHP binary that Process names, so it sees the same Redis connection and configuration that Horizon sees. The script reads Horizon’s own repositories and changes nothing. It does not call the application over HTTP, so the authorization gate of the Horizon dashboard does not apply, and a production Instance reports the same way as a development one. The caller supplies only state and limit. The Gateway validates both and passes each as one command argument.

​

Know what the Gateway never returns

A job payload can hold customer data, so the script never prints one. For a failed job it prints only the first line of the exception, because the lines after it are a stack trace with arguments. The report is printed inside the application, so the Gateway treats it as untrusted: it casts and bounds every value again and passes on only the fields in the table above. It builds a job url only from an id of letters, digits, and hyphens.

​

Handle a failed read

A failed read returns an Orbit error with one of these codes. A report is never part of an error.