如何在VSCode中配置Laravel Horizon Laravel队列监控界面开发配置技巧

配置 laravel horizon 的步骤包括安装 horizon、发布配置文件、配置队列连接、设置访问权限、运行 horizon 以及访问监控界面。首先，使用 composer 安装 horizon：composer require laravel/horizon。其次，通过 php artisan vendor:publish --tag=horizon-config 发布配置文件。接着，在 .env 文件中将 queue_connection 设置为 redis 并确保 redis 正常运行。然后，在 horizonserviceprovider.php 中定义 gate 来限制访问用户，例如通过邮箱验证。运行 php artisan horizon 启动守护进程，并在浏览器中访问 /horizon 查看监控界面。常见问题包括 redis 连接异常、队列驱动配置错误、horizon 进程未启动、权限限制及任务执行失败，需逐一排查。若需自定义监控指标，可创建监听器监听 horizon::stats() 事件，在 handle 方法中添加指标（如 cpu 使用率），并在 eventserviceprovider.php 中注册监听器，最后重启 horizon。优化性能的方法包括调整进程数量、设置队列优先级、使用 supervisor 管理进程、优化任务代码、选择更快的队列驱动。

配置 Laravel Horizon 并非难事，核心在于确保你的 Laravel 项目已经正确设置了队列，并且安装了 Redis 或其他 Horizon 支持的队列驱动。接下来，我们一步步完成配置，让你的队列监控界面跑起来。

解决方案

1. 安装 Horizon:

   首先，通过 Composer 安装 Horizon：

   

   composer require laravel/horizon

   登录后复制

2. 发布 Horizon 配置文件:

   运行以下 Artisan 命令发布 Horizon 的配置文件到 config 目录：

   

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

   登录后复制

   这个命令会在 config/horizon.php 创建一个配置文件，你可以在这里自定义 Horizon 的行为。

3. 配置队列连接:

   打开 .env 文件，确保 QUEUE_CONNECTION 设置为 redis（或其他你选择的队列驱动）。

   QUEUE_CONNECTION=redis

   登录后复制

   同时，确保 Redis 服务器已启动并运行。如果你使用的是 Docker，确保 Redis 容器已经启动。

4. 配置 Horizon 访问权限:

   Horizon 默认需要登录才能访问。你可以在 app/Providers/HorizonServiceProvider.php 中自定义访问权限。

   use Laravel\Horizon\Horizon;
   use Illuminate\Support\Facades\Gate;
   
   /**
    * Bootstrap any application services.
    *
    * @return void
    */
   public function boot()
   {
       parent::boot();
   
       Gate::define('viewHorizon', function ($user) {
           return in_array($user->email, [
               'your_email@example.com', // 允许特定邮箱的用户访问
           ]);
       });
   
       Horizon::auth(function ($request) {
           return app('auth')->check() && Gate::check('viewHorizon', app('auth')->user());
       });
   }

   登录后复制

   上面的代码示例允许特定邮箱的用户访问 Horizon。当然，你可以根据自己的需求修改权限验证逻辑。

5. 运行 Horizon:

   运行以下 Artisan 命令启动 Horizon：

   php artisan horizon

   登录后复制

   这个命令会启动一个守护进程，监控你的队列并处理任务。

6. 访问 Horizon 界面:

   在浏览器中访问 /horizon，你应该能看到 Horizon 的监控界面。

Horizon 监控界面常见问题排查

Horizon 界面一片空白？任务处理速度异常缓慢？这些都是使用 Horizon 时可能遇到的问题。

1. Redis 连接问题: 确保 Redis 服务器正常运行，并且 Laravel 应用可以连接到 Redis。检查 .env 文件中的 REDIS_HOST、REDIS_PORT 和 REDIS_PASSWORD 是否正确。可以使用 redis-cli ping 命令测试 Redis 连接。

2. 队列驱动配置错误: 确保 QUEUE_CONNECTION 设置为 redis，并且 config/queue.php 中的 redis 配置正确。

3. Horizon 进程未启动: 运行 php artisan horizon:status 检查 Horizon 进程是否正在运行。如果未运行，使用 php artisan horizon 启动它。如果仍然无法启动，检查 Laravel 的日志文件（storage/logs/laravel.log）是否有错误信息。

4. Horizon 权限问题: 确保你的用户有权访问 Horizon 界面。检查 app/Providers/HorizonServiceProvider.php 中的权限验证逻辑。

5. 任务执行失败: 检查 Laravel 的日志文件，查找任务执行失败的错误信息。可能是任务代码存在 bug，或者依赖的服务不可用。

   

   冬瓜配音

   AI在线配音生成器

   66

   查看详情

如何自定义 Horizon 监控指标

Horizon 默认提供了一些监控指标，例如队列长度、任务处理速度等。如果你需要监控其他指标，例如 CPU 使用率、内存占用率等，可以使用 Horizon 的事件监听器来实现。

1. 创建事件监听器:

   创建一个新的事件监听器，监听 Horizon 的 Horizon::stats() 事件。

   php artisan make:listener HorizonStatsListener

   登录后复制

2. 修改事件监听器:

   打开 app/Listeners/HorizonStatsListener.php 文件，修改 handle 方法，添加自定义的监控指标。

   namespace App\Listeners;
   
   use Laravel\Horizon\Events\Stats;
   use Illuminate\Contracts\Queue\ShouldQueue;
   use Illuminate\Queue\InteractsWithQueue;
   
   class HorizonStatsListener
   {
       /**
        * Handle the event.
        *
        * @param  Stats  $event
        * @return void
        */
       public function handle(Stats $event)
       {
           $event->stats['cpu_usage'] = sys_getloadavg()[0]; // 获取 CPU 使用率
   
           // 添加其他自定义监控指标
       }
   }

   登录后复制

3. 注册事件监听器:

   在 app/Providers/EventServiceProvider.php 文件中注册事件监听器。

   protected $listen = [
       \Laravel\Horizon\Events\Stats::class => [
           \App\Listeners\HorizonStatsListener::class,
       ],
   ];

   登录后复制

4. 重启 Horizon:

   重启 Horizon 进程，使新的事件监听器生效。

   php artisan horizon:terminate
   php artisan horizon

   登录后复制

   现在，你应该能在 Horizon 界面上看到自定义的监控指标了。

优化 Horizon 性能的技巧

Horizon 的性能直接影响到队列的处理速度。以下是一些优化 Horizon 性能的技巧：

1. 调整进程数量:

   在 config/horizon.php 文件中，调整 environments 配置中的 processes 选项，增加或减少进程数量，以适应你的应用负载。

2. 调整队列优先级:

   在 config/horizon.php 文件中，调整 environments 配置中的 balance 选项，设置队列的优先级。simple 策略会按照队列的顺序处理任务，auto 策略会根据队列的长度动态调整优先级。

3. 使用 Supervisor 管理 Horizon 进程:

   使用 Supervisor 这样的进程管理工具来管理 Horizon 进程，可以确保 Horizon 进程始终运行，并且在进程崩溃时自动重启。

4. 优化任务代码:

   确保你的任务代码高效且没有阻塞操作。避免在任务中执行耗时的数据库查询或网络请求。

5. 使用更快的队列驱动:

   如果你的应用对性能要求很高，可以考虑使用更快的队列驱动，例如 Beanstalkd。

总而言之，配置 Laravel Horizon 并不复杂，关键在于理解其工作原理，并根据实际情况进行调整。希望以上内容能帮助你更好地使用 Horizon，提升你的 Laravel 应用的性能。

以上就是如何在VSCode中配置Laravel Horizon Laravel队列监控界面开发配置技巧的详细内容，更多请关注php中文网其它相关文章！