README

Larasapien for Laravel

此包为Larasapien API创建了一个端点。一旦安装，您就可以使用此端点将您的应用程序连接到Larasapien账户。

默认情况下，此包将报告以下信息

• Laravel、PHP和Larasapien包版本
• 缓存状态
• 环境类型
• 调试模式值
• CPU负载
• Redis和Horizon状态
• 调度状态
• Git分支和最后提交哈希

您可以通过您的Larasapien配置文件禁用这些检查中的任何一个。

安装

1. 使用以下命令通过composer安装此包

composer require ellipticmarketing/larasapien

1. 将您的Larasapien项目令牌添加到您的.env文件中

LARASAPIEN_TOKEN={{your-token}}

您可以在Larasapien仪表板上找到您的项目令牌。

1. 可选：发布配置文件

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

使用方法

安装包后，它将为Larasapien端点创建一个新的路由。默认情况下，此路由将在/_larasapien处可用。此包将仅服务包含Larasapien令牌的请求。

除了通过Larasapien检索您应用程序的状态外，您还可以使用以下命令在本地进行检查：php artisan larasapien:check。

配置调度检查器

为了使调度检查器工作，需要每五分钟调用一次ScheduleChecker命令。

该命令可以在您的应用程序的console Kernel中安排，位于app/Console/Kernel.php下。

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

use EllipticMarketing\Larasapien\Checkers\ScheduleChecker;

class Kernel extends ConsoleKernel
{
    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        // ...
        
        $schedule->call(new ScheduleChecker)->everyFiveMinutes();
    }
}

启用特定检查

在某些情况下，您可能不想运行所有检查。例如，如果您的应用程序不使用Redis，您可能想禁用Redis检查。

要禁用某些检查，您可以在您的config/larasapien.php文件中注释掉适当的类。

return [
    'token' => env('LARASAPIEN_TOKEN'),

    'checkers' => [
        EllipticMarketing\Larasapien\Checkers\GitChecker::class,
        EllipticMarketing\Larasapien\Checkers\CacheChecker::class,
        EllipticMarketing\Larasapien\Checkers\CpuLoadChecker::class,
        // EllipticMarketing\Larasapien\Checkers\HorizonChecker::class,
        // EllipticMarketing\Larasapien\Checkers\RedisChecker::class,
        EllipticMarketing\Larasapien\Checkers\ScheduleChecker::class,
    ],
];

致谢

许多检查都受到了由Spatie创建的Laravel-health包的启发。

许可

您可以使用此包将您的应用程序连接到您的Larasapien.com账户。

此包提供“原样”且无任何保证。使用受Larasapien条款和条件约束。

Elliptic Marketing, LLC - 版权所有。