First commit

Author: chrisbjr

.gitignore

@@ -0,0 +1,10 @@
+/.idea
+/vendor
+/node_modules
+package-lock.json
+composer.phar
+composer.lock
+phpunit.xml
+.phpunit.result.cache
+.DS_Store
+Thumbs.db

README.md

@@ -0,0 +1,40 @@
+# Laravel Healthcheck
+
+This package provides a simple healthcheck endpoint for your Laravel application.
+
+![Import Action](https://raw.githubusercontent.com/coreproc/laravel-healthcheck/main/docs/healthcheck.png)
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require coreproc/laravel-healthcheck
+```
+
+Publish the config file:
+
+```bash
+php artisan vendor:publish --provider="Coreproc\LaravelHealthcheck\HealthcheckServiceProvider"
+```
+
+## Usage
+
+Once installed, you can access the healthcheck endpoint at `/healthcheck`.
+
+You can configure the path in the `config/healthcheck.php` file along with specifying which services you want to check.
+
+```php
+// config/healthcheck.php
+return [
+
+    'path' => 'healthcheck',
+
+    'database' => true,
+
+    'redis' => true,
+
+    'horizon' => true,
+
+];
+```

composer.json

@@ -0,0 +1,25 @@
+{
+  "name": "coreproc/laravel-healthcheck",
+  "type": "library",
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "Coreproc\\LaravelHealthcheck\\": "src/"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Coreproc\\LaravelHealthcheck\\HealthcheckServiceProvider"
+      ]
+    }
+  },
+  "authors": [
+    {
+      "name": "Chris Bautista",
+      "email": "chris.bautista@coreproc.com"
+    }
+  ],
+  "minimum-stability": "dev",
+  "require": {}
+}

config/healthcheck.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+
+    'path' => 'healthcheck',
+
+    'database' => true,
+
+    'redis' => true,
+
+    'horizon' => true,
+
+];

docs/healthcheck.png

@@ -0,0 +1,5 @@
+<?php
+
+use Coreproc\LaravelHealthcheck\HealthCheckController;
+
+Route::get(config('healthcheck.path', 'healthcheck'), HealthCheckController::class);

routes/healthcheck.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Coreproc\LaravelHealthcheck;
+
+use Exception;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Routing\Controller;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Redis;
+use Laravel\Horizon\Contracts\MasterSupervisorRepository;
+
+class HealthCheckController extends Controller
+{
+    public function __invoke(): JsonResponse
+    {
+        $status = 200; // Default status code is OK
+
+        $response = [];
+
+        // Check database connection
+        if (config('healthcheck.database', true) === true) {
+            try {
+                DB::connection()->getPdo();
+                $dbStatus = 'OK';
+            } catch (Exception $e) {
+                $status = 500;
+                $dbStatus = 'Unable to connect to the database: ' . $e->getMessage();
+            }
+            $response['db_status'] = $dbStatus;
+        }
+
+        // Check Redis connection
+        if (config('healthcheck.redis', true) === true) {
+            try {
+                Redis::ping();
+                $redisStatus = 'OK';
+            } catch (Exception $e) {
+                $status = 500;
+                $redisStatus = 'Unable to connect to Redis: ' . $e->getMessage();
+            }
+            $response['redis_status'] = $redisStatus;
+        }
+
+        // Check Horizon status
+        if (config('healthcheck.horizon', true) === true) {
+            $horizonStatus = 'Queue driver is not Redis';
+            if (config('queue.default') === 'redis') {
+                $horizonCurrentStatus = $this->horizonCurrentStatus();
+                $horizonStatus = 'Horizon is currently ' . $horizonCurrentStatus;
+                if ($horizonCurrentStatus === 'running') {
+                    $horizonStatus = 'OK';
+                }
+            }
+            $response['horizon_status'] = $horizonStatus;
+        }
+
+        // Assign status to the response but put it in the beginning of the array
+        $response = array_merge(['status' => $status], $response);
+
+        return response()->json($response, $status);
+    }
+
+    protected function horizonCurrentStatus(): string
+    {
+        if (!$masters = app(MasterSupervisorRepository::class)->all()) {
+            return 'inactive';
+        }
+
+        return collect($masters)->every(function ($master) {
+            return $master->status === 'paused';
+        }) ? 'paused' : 'running';
+    }
+}

src/HealthCheckController.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Coreproc\LaravelHealthcheck;
+
+use Illuminate\Support\ServiceProvider;
+
+class HealthcheckServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        // Publish config file
+        $this->publishes([
+            __DIR__ . '/../config/healthcheck.php' => config_path('healthcheck.php'),
+        ], 'healthcheck-config');
+
+        $this->loadRoutesFrom(__DIR__ . '/../routes/healthcheck.php');
+    }
+}