42

Product support

Get help in the plugin support forum.

Categories

Vdlp.Horizon

Provides a seamless integration of Laravel Horizon 2.0 inside OctoberCMS.

Laravel Horizon 3.0 is not yet supported, minimal requirements are Laravel Framework 5.8. OctoberCMS depends on Laravel Framework 5.5

Laravel Horizon Logo

Queues, With X-Ray Vision. Supercharge your queues with a beautiful dashboard and code-driven configuration.

Laravel Horizon Dashboard

A match made in heaven

Horizon is developed by the core developers of the Laravel framework and provides a robust queue monitoring solution for Laravel's Redis queue. Horizon allows you to easily monitor key metrics of your queue system such as job throughput, runtime, and job failures.

Open Source

Horizon is 100% open source, so you're free to dig through the source to see exactly how it works. See something that needs to be improved? Just send us a pull request on GitHub.

Requirements

Documentation

Follow our complete installation and configuration documentation on the Documentation tab in the OctoberCMS Marketplace.

For more information go to the Laravel website for detailed documentation about Laravel Horizon.

Horizon for Laravel 5.5

Questions

If you have any question about how to use this plugin, please don't hesitate to contact us at octobercms@vdlp.nl. We're happy to help you. You can also visit the support forum and drop your questions/issues there.

Dashboard

Requirements

Installation

Install the plugin from CLI using this command:

php artisan plugin:install Vdlp.Horizon

Or install it from the October Marketplace. And update dependencies from root of your OctoberCMS project:

composer update laravel/horizon

Turn off auto discovery for laravel/horizon (important)

Because this plugin has it's own HorizonServiceProvider which extends from the Laravel\Horizon\HorizonServiceProvider we need to prevent the Laravel\Horizon\HorizonServiceProvider from being loaded due to Laravels' auto package discovery.

You should add the dont-discover option to your projects composer.json file (which is located in the root path of your project).

"extra": {
    "merge-plugin": {
        ...
    },
    "laravel": {
        "dont-discover": [
            "laravel/horizon"
        ]
    }
}

IMPORTANT: After adding these lines, make sure you execute composer update to apply the changes. You also need to remove the file storage/framework/packages.php file. No worries. This file will be re-generated once you access your project.

IMPORTANT: Make sure the composer.json is deployed to your hosting site. This will be parsed by te framework to determine which service providers should be ignored.

Assets

  • Run the command to publish assets for the Horizon dashboard:
php artisan vendor:publish --tag horizon-assets --force

Configuration

  • Run the command to publish configuration file config/horizon.php:
php artisan vendor:publish --tag horizon-config --force
  • Configure Laravel Horizon settings file at config/horizon.php, please make sure use contains horizon (see the configuration snippet below).
    /*
    |--------------------------------------------------------------------------
    | Horizon Redis Connection
    |--------------------------------------------------------------------------
    |
    | This is the name of the Redis connection where Horizon will store the
    | meta information required for it to function. It includes the list
    | of supervisors, failed jobs, job metrics, and other information.
    |
    */

    'use' => 'horizon',
  • Add connection to config/queue.php:
    'redis' => [

        'driver' => env('QUEUE_DRIVER', 'redis'),
        'connection' => env('QUEUE_CONNECTION', 'horizon'),
        'queue' => env('QUEUE_DEFAULT', 'default'),
        'retry_after' => env('QUEUE_RETRY_AFTER', 90),
        'block_for' => null,

    ],
  • Add Redis database configuration for Horizon specifically to config/databases.php:
    'redis' => [

        'cluster' => false,
        'client' => 'phpredis',

        'default' => [
            // ..
        ],

        'horizon' => [
            'host' => env('HORIZON_REDIS_HOST', '127.0.0.1'),
            'password' => env('HORIZON_REDIS_PASSWORD'),
            'port' => env('HORIZON_REDIS_PORT', 6379),
            'database' => env('HORIZON_REDIS_DATABASE', '1'),
        ]

    ],
  • Modify the queue driver QUEUE_DRIVER (can be found in config/queue.php) to redis as such:
    /*
    |--------------------------------------------------------------------------
    | Default Queue Driver
    |--------------------------------------------------------------------------
    |
    | The Laravel queue API supports a variety of back-ends via an unified
    | API, giving you convenient access to each back-end using the same
    | syntax for each one. Here you may set the default queue driver.
    |
    | Supported: "null", "sync", "database", "beanstalkd",
    |            "sqs", "iron", "redis"
    |
    */

    'default' => env('QUEUE_DRIVER', 'redis'),
  • .env should at least have the following QUEUE_ and HORIZON_ variables:
;
; Queue
;
QUEUE_DRIVER = "redis"
QUEUE_CONNECTION = "horizon"
QUEUE_DEFAULT = "default"
QUEUE_RETRY_AFTER = 90

;
; Horizon
;
HORIZON_PREFIX = "myproject-local:"
HORIZON_FAST_TERMINATION = false
HORIZON_MEMORY_LIMIT = 64

HORIZON_REDIS_HOST = "127.0.0.1"
HORIZON_REDIS_PASSWORD = null
HORIZON_REDIS_PORT = 6379
HORIZON_REDIS_DATABASE = "1"

HORIZON_MAIL_NOTIFICATIONS_ENABLED=false
HORIZON_MAIL_NOTIFICATIONS_TO=null

HORIZON_SLACK_NOTIFICATIONS_ENABLED=false
HORIZON_SLACK_NOTIFICATIONS_WEBHOOK_URL=null
HORIZON_SLACK_NOTIFICATIONS_CHANNEL=null

HORIZON_SMS_NOTIFICATIONS_ENABLED=false
HORIZON_SMS_NOTIFICATIONS_TO=null

It's recommended to add your Queue Worker Configuration config.horizon.environments to the .env file as well.

Server configuration

  • Add the following to the supervisord configuration on the server. The complete supervisord configuration can be found on the supervisor website.
[program:<queue-name>-queue]
process_name=%(program_name)s_%(process_num)02d
directory=/<myproject-directory>
command=/<path-to-php>/php /<myproject-directory>/artisan horizon
autostart=true
autorestart=true
user=<user>
numprocs=1
redirect_stderr=true
stdout_logfile=/var/log/supervisord/<queue-name>-queue.log
  • Add the following to the cronjob configuration on the server. This will make sure the Horizon metrics are created periodically.
* * * * * /<path-to-php>/php /<myproject-directory>/artisan schedule:run > /dev/null

Switching themes

Each time you switch the default theme you need to re-publish the Horizon assets using the command: php artisan vendor:publish --tag horizon-assets --force

The assets will be stored in your current theme folder: themes/mytheme/assets/horizon folder.

CMS configuration

Configuration options for Horizon can be found in the Settings section of OctoberCMS.

URL: /backend/system/settings/update/vdlp/horizon/horizon-configuration

Other configuration should be done by modifying config/horizon.php as mentioned before.

Creating Job classes

Follow the instructions at Laravel 5.5 generating job classes on how to make Job classes.

Please note that the use of the php artisan make:job command is not supported in OctoberCMS. OctoberCMS is using a different application structure in comparison to a generic Laravel project.

This plugin also contains an example job file: Vdlp\Horizon\Example. This example file does not use the SerializesModels and InteractsWithQueue trait.

Testing

  1. Log-in to the backend.
  2. Put application in debug mode using the .env file: APP_DEBUG=true or by changing the debug key in the config/app.php file.
  3. Run Horizon using this command: php artisan horizon.
  4. Now run this command to push some Vdlp\Horizon\Example jobs to the queue:
php artisan vdlp:horizon:push-example-jobs
  1. Check the Horizon dashboard at /backend/vdlp/horizon/dashboard or at /horizon.
  2. Each Vdlp\Horizon\Example job should log a random string to the application log (level = debug).
  • Found the plugin not useful on 13 Jun, 2019

    I cannot install this plugin, it throw an exception:

    Class 'Laravel\Horizon\HorizonServiceProvider' not found

    I have added the follow code in composer.json:

    "laravel": {
        "dont-discover": [
            "laravel/horizon"
        ]
    }

  • author

    Replied on 13 Jun, 2019

    Hi Jason,

    This is mentioned (as important) in the README.md and on the Documentation page of this plugin:

    Turn off auto discovery for laravel/horizon (important)

    Because this plugin has it's own HorizonServiceProvider which extends from the Laravel\Horizon\HorizonServiceProvider we need to prevent the Laravel\Horizon\HorizonServiceProvider from being loaded due to Laravels' auto package discovery.

    You should add the dont-discover option to your projects composer.json file (which is located in the root path of your project).

    "extra": {
        "merge-plugin": {
            ...
        },
        "laravel": {
            "dont-discover": [
                "laravel/horizon"
            ]
        }
    }

2.0.0

Update laravel/horizon to 2.0 (see README.md for instructions)

Apr 12, 2019

1.0.3

Update plugin documentation

Apr 12, 2019

1.0.2

Update plugin documentation

Apr 12, 2019

1.0.1

Fix registering issues with the Horizon Service Provider

Apr 12, 2019

1.0.0

First version of Vdlp.Horizon

Apr 12, 2019