ohdearapp/ohdear-pulse

将 Oh Dear 与 Laravel Pulse 集成

1.1.0 2024-03-28 12:00 UTC

This package is not auto-updated.

Last update: 2024-09-13 19:59:51 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

此包包含 Pulse 卡片,可在您的 Laravel Pulse 控制台中显示来自 Oh Dear 的结果。

目前有三种卡片可用

screenshot

screenshot

安装

您可以通过 composer 安装此包

composer require ohdearapp/ohdear-pulse

在您的 config/services.php 文件中,添加以下行

'oh_dear' => [
    'pulse' => [
        'api_key' => env('OH_DEAR_API_TOKEN'),
        'site_id' => env('OH_DEAR_SITE_ID'),
    ],
],

您可以在 Oh Dear 的“API Tokens”页面创建 API 令牌。您可以在 Oh Dear 网站设置页面找到站点 ID。

您可以使用以下 artisan 命令来验证是否正确设置了配置。

php artisan ohdear-pulse:verify

用法

目前有三种卡片可用

  • ohdear.pulse.uptime:显示网站的 uptime 和性能
  • ohdear.pulse.cron:显示 cron 作业监控的结果
  • ohdear.pulse.brokenLinks:显示检测到的任何断链

您可以通过首先发布 Pulse 的仪表板视图来将卡片添加到您的 Pulse 仪表板

php artisan vendor:publish --tag=pulse-dashboard

接下来,将卡片添加到 resources/views/vendor/pulse/dashboard.blade.php 文件

<x-pulse>
    <livewire:ohdear.pulse.uptime cols="4" />
    
    <livewire:ohdear.pulse.cron cols="8" />

    <livewire:ohdear.pulse.brokenLinks cols="8" />
    
    {{-- Add more cards here --}}
</x-pulse>

所有这些卡片都接受一个可选的 site-id 属性。如果您不提供它,将使用 config/services.php 文件中的网站 ID。

测试

composer test

更新日志

请参阅 更新日志 了解最近更改的更多信息。

贡献

请参阅 贡献指南 了解详细信息。

安全漏洞

请查看 我们的安全策略 了解如何报告安全漏洞。

鸣谢

许可

MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。