wt-health/laravel-health-check

Check versions of vital parts of the application

v1.0.0 2024-05-21 20:16 UTC

Requires

• php: ^8.2|^8.3
• composer/composer: ^2
• illuminate/support: ^9.0|^10.0|^11.0
• spatie/laravel-health: ^1.27
• spatie/laravel-package-tools: ^1.16.4

Requires (Dev)

• larastan/larastan: ^2.0
• laravel/pint: ^1.15
• orchestra/testbench: ^7.0|^8.0|^9.0
• phpunit/phpunit: ^11
• timacdonald/log-fake: ^2.2

MIT

• Fernando Guedes

README

Laravel Health Check

Adds custom version check based on spatie/laravel-health

Installation & Configuration

 composer require wthealth/laravel-health-check

To have logs and metrics logged in Datadog, you must schedule health check command on your setup.

serverless.yaml

    artisan:
        handler: artisan
        runtime: php-83-console
        timeout: 720 # in seconds
        layers:
            - ${bref-extra:gd-php-83}
            - ${bref-extra:redis-php-83}
        events:
            - schedule:
                  rate: rate(12 hours)
                  input: '"health:check"'

Usage

You may configure these environment variable below accordingly

HEALTH_API_ROUTE_ENABLED= # enable /health-check endpoint - default: false
HEALTH_API_KEY= # used to secure /health-check endpoint
HEALTH_API_PACKAGES= # packages ( comma separated ) to have its versions checked

You can health check either accessing /health-check endpoint or running php artisan health:list --fresh

A schedule job runs every day and output logs that are ingested by Datadog

License

The MIT License (MIT). Please see License File for more information.