Implement API health route

Author: danieltrolezi

app/Providers/AppServiceProvider.php

@@ -3,6 +3,11 @@
 namespace App\Providers;
 
 use Illuminate\Support\ServiceProvider;
+use Spatie\Health\Checks\Checks\DatabaseCheck;
+use Spatie\Health\Checks\Checks\EnvironmentCheck;
+use Spatie\Health\Checks\Checks\RedisCheck;
+use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck;
+use Spatie\Health\Facades\Health;
 
 class AppServiceProvider extends ServiceProvider
 {
@@ -19,6 +24,16 @@ public function register(): void
      */
     public function boot(): void
     {
-        //
+        $env = match (config('app.url')) {
+            'http://laravel-app.local' => 'local',
+            default => 'production'
+        };
+
+        Health::checks([
+            EnvironmentCheck::new()->expectEnvironment($env),
+            UsedDiskSpaceCheck::new(),
+            DatabaseCheck::new(),
+            RedisCheck::new()
+        ]);
     }
 }

composer.json

@@ -10,7 +10,7 @@
         "laravel/sanctum": "^4.0",
         "laravel/tinker": "^2.9",
         "leventcz/laravel-top": "^1.1",
-        "livewire/livewire": "^3.0",
+        "spatie/laravel-health": "^1.30",
         "zircote/swagger-php": "^4.10"
     },
     "require-dev": {

config/health.php

@@ -0,0 +1,127 @@
+<?php
+
+return [
+    /*
+     * A result store is responsible for saving the results of the checks. The
+     * `EloquentHealthResultStore` will save results in the database. You
+     * can use multiple stores at the same time.
+     */
+    'result_stores' => [
+        Spatie\Health\ResultStores\EloquentHealthResultStore::class => [
+            'connection' => env('HEALTH_DB_CONNECTION', env('DB_CONNECTION')),
+            'model' => Spatie\Health\Models\HealthCheckResultHistoryItem::class,
+            'keep_history_for_days' => 5,
+        ],
+
+        /*
+        Spatie\Health\ResultStores\CacheHealthResultStore::class => [
+            'store' => 'file',
+        ],
+
+        Spatie\Health\ResultStores\JsonFileHealthResultStore::class => [
+            'disk' => 's3',
+            'path' => 'health.json',
+        ],
+
+        Spatie\Health\ResultStores\InMemoryHealthResultStore::class,
+        */
+    ],
+
+    /*
+     * You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
+     * For Slack you need to install laravel/slack-notification-channel.
+     */
+    'notifications' => [
+        /*
+         * Notifications will only get sent if this option is set to `true`.
+         */
+        'enabled' => false,
+
+        'notifications' => [
+            Spatie\Health\Notifications\CheckFailedNotification::class => ['mail'],
+        ],
+
+        /*
+         * Here you can specify the notifiable to which the notifications should be sent. The default
+         * notifiable will use the variables specified in this config file.
+         */
+        'notifiable' => Spatie\Health\Notifications\Notifiable::class,
+
+        /*
+         * When checks start failing, you could potentially end up getting
+         * a notification every minute.
+         *
+         * With this setting, notifications are throttled. By default, you'll
+         * only get one notification per hour.
+         */
+        'throttle_notifications_for_minutes' => 60,
+        'throttle_notifications_key' => 'health:latestNotificationSentAt:',
+
+        'mail' => [
+            'to' => 'your@example.com',
+
+            'from' => [
+                'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
+                'name' => env('MAIL_FROM_NAME', 'Example'),
+            ],
+        ],
+
+        'slack' => [
+            'webhook_url' => env('HEALTH_SLACK_WEBHOOK_URL', ''),
+
+            /*
+             * If this is set to null the default channel of the webhook will be used.
+             */
+            'channel' => null,
+
+            'username' => null,
+
+            'icon' => null,
+        ],
+    ],
+
+    /*
+     * You can let Oh Dear monitor the results of all health checks. This way, you'll
+     * get notified of any problems even if your application goes totally down. Via
+     * Oh Dear, you can also have access to more advanced notification options.
+     */
+    'oh_dear_endpoint' => [
+        'enabled' => false,
+
+        /*
+         * When this option is enabled, the checks will run before sending a response.
+         * Otherwise, we'll send the results from the last time the checks have run.
+         */
+        'always_send_fresh_results' => true,
+
+        /*
+         * The secret that is displayed at the Application Health settings at Oh Dear.
+         */
+        'secret' => env('OH_DEAR_HEALTH_CHECK_SECRET'),
+
+        /*
+         * The URL that should be configured in the Application health settings at Oh Dear.
+         */
+        'url' => '/oh-dear-health-check-results',
+    ],
+
+    /*
+     * You can set a theme for the local results page
+     *
+     * - light: light mode
+     * - dark: dark mode
+     */
+    'theme' => 'light',
+
+    /*
+     * When enabled,  completed `HealthQueueJob`s will be displayed
+     * in Horizon's silenced jobs screen.
+     */
+    'silence_health_queue_job' => true,
+
+    /*
+     * The response code to use for HealthCheckJsonResultsController when a health
+     * check has failed
+     */
+    'json_results_failure_status' => 200,
+];

database/migrations/2024_08_14_210442_create_health_tables.php

@@ -0,0 +1,36 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Spatie\Health\Models\HealthCheckResultHistoryItem;
+use Spatie\Health\ResultStores\EloquentHealthResultStore;
+
+return new class extends Migration
+{
+    public function up()
+    {
+        $connection = (new HealthCheckResultHistoryItem())->getConnectionName();
+        $tableName = EloquentHealthResultStore::getHistoryItemInstance()->getTable();
+    
+        Schema::connection($connection)->create($tableName, function (Blueprint $table) {
+            $table->id();
+
+            $table->string('check_name');
+            $table->string('check_label');
+            $table->string('status');
+            $table->text('notification_message')->nullable();
+            $table->string('short_summary')->nullable();
+            $table->json('meta');
+            $table->timestamp('ended_at');
+            $table->uuid('batch');
+
+            $table->timestamps();
+        });
+        
+        Schema::connection($connection)->table($tableName, function(Blueprint $table) {
+            $table->index('created_at');
+            $table->index('batch');
+        });
+    }
+};

routes/api.php

@@ -8,9 +8,11 @@
 use App\Http\Controllers\RawgGamesController;
 use App\Http\Controllers\RawgDomainController;
 use Illuminate\Support\Facades\Route;
+use Spatie\Health\Http\Controllers\HealthCheckJsonResultsController;
 
 Route::permanentRedirect('/docs', '/swagger/index.html');
 
+Route::get('/health', HealthCheckJsonResultsController::class);
 Route::post('/account/register', [AccountController::class, 'register']);
 Route::post('/auth/login', [AuthController::class, 'login']);