alfasix / alfakit-health

v0.1.8 2026-10-21 10:27 UTC

Requires

• php: ^8.4
• alfasix/alfakit: ^0.1|@dev
• spatie/laravel-health: ^1.30

MIT

• Alfa Six

• monitoring
• health
• laravel
• spatie
• alfakit

Published on Packagist.org on 2026-10-22 11:22 UTC

README

_{by Alfa Six}

This is a read-only split of the AlfaKit monorepo. Please open issues and pull requests there.

Spatie Laravel Health for AlfaKit panels: a Health page with the latest result of every check, a refresh action that runs the checks, and an optional dashboard widget summarising failures. It renders in React, Vue and Svelte with AlfaKit's built-in components.

Installation

composer require alfasix/alfakit-health

Install spatie/laravel-health, register your checks and a result store, and register the plugin:

use AlfaSix\AlfakitHealth\HealthPlugin;

$panel->plugin(
    HealthPlugin::make()
        ->dashboardWidget()
        ->authorize(fn (User $user): bool => $user->is_admin),
);

The page is at /{panel}/health.

Usage

• A card per check: label, short summary, message, status colour and icon.
• A details table with each check's status, summary, message and meta values.
• Refresh runs health:check --no-notification (notifyOnRefresh() sends spatie's notifications).
• dashboardWidget() adds HealthStatusWidget: "All checks passed", or the failing checks, linking to the page.

Other options: usingPage(), usingPollingInterval(), navigationGroup(), navigationLabel(), navigationIcon(), navigationSort(), registerNavigation(). See the documentation.

License

MIT. See LICENSE.md.