Component Monitoring (#211)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: jbrooksuk

database/factories/ComponentCheckFactory.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Cachet\Database\Factories;
+
+use Cachet\Enums\ComponentStatusEnum;
+use Cachet\Models\Component;
+use Cachet\Models\ComponentCheck;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends Factory<ComponentCheck>
+ */
+class ComponentCheckFactory extends Factory
+{
+    protected $model = ComponentCheck::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'component_id' => Component::factory(),
+            'status' => ComponentStatusEnum::operational,
+            'successful' => true,
+            'response_code' => 200,
+            'response_time' => fake()->numberBetween(20, 800),
+            'checked_at' => now(),
+        ];
+    }
+}

database/factories/ComponentFactory.php

@@ -40,6 +40,17 @@ public function enabled(): self
         ]);
     }
 
+    /**
+     * Create a component that is monitored via a link check.
+     */
+    public function checked(): self
+    {
+        return $this->state([
+            'checked' => true,
+            'link' => fake()->url(),
+        ]);
+    }
+
     /**
      * Create a component that is disabled
      */

database/migrations/2025_01_21_171353_add_checked_at_column_to_components_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('components', function (Blueprint $table) {
+            $table->boolean('checked')->default(false)->after('enabled');
+            $table->timestamp('checked_at')->nullable()->after('checked');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('components', function (Blueprint $table) {
+            $table->dropColumn([
+                'checked',
+                'checked_at',
+            ]);
+        });
+    }
+};

database/migrations/2025_09_14_000000_create_component_checks_table.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('component_checks', function (Blueprint $table) {
+            $table->id();
+            $table->foreignId('component_id')->constrained('components')->cascadeOnDelete();
+            $table->unsignedTinyInteger('status');
+            $table->boolean('successful')->default(false);
+            $table->unsignedSmallInteger('response_code')->nullable();
+            $table->unsignedInteger('response_time')->nullable();
+            $table->timestamp('checked_at');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('component_checks');
+    }
+};

resources/lang/en/component.php

@@ -10,6 +10,8 @@
             'group' => 'Group',
             'enabled' => 'Enabled',
             'created_at' => 'Created at',
+            'checked' => 'Monitored',
+            'checked_at' => 'Checked at',
             'updated_at' => 'Updated at',
             'deleted_at' => 'Deleted at',
         ],
@@ -27,6 +29,7 @@
         'component_group_label' => 'Component Group',
         'link_label' => 'Link',
         'link_helper' => 'An optional link to the component.',
+        'checked_label' => 'Whether to periodically check the component.',
     ],
     'status' => [
         'operational' => 'Operational',
@@ -36,5 +39,19 @@
         'under_maintenance' => 'Under maintenance',
         'unknown' => 'Unknown',
     ],
+    'checks' => [
+        'title' => 'Recent checks',
+        'empty_state' => [
+            'heading' => 'No checks yet',
+            'description' => 'Checks will appear here once the component has been monitored.',
+        ],
+        'headers' => [
+            'status' => 'Status',
+            'successful' => 'Successful',
+            'response_code' => 'Response code',
+            'response_time' => 'Response time',
+            'checked_at' => 'Checked at',
+        ],
+    ],
 
 ];

src/CachetCoreServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Cachet;
 
 use BladeUI\Icons\Factory;
+use Cachet\Commands\CheckComponentsCommand;
 use Cachet\Commands\MakeUserCommand;
 use Cachet\Commands\SendBeaconCommand;
 use Cachet\Commands\VersionCommand;
@@ -182,6 +183,7 @@ private function registerCommands(): void
     {
         if ($this->app->runningInConsole()) {
             $this->commands([
+                CheckComponentsCommand::class,
                 MakeUserCommand::class,
                 SendBeaconCommand::class,
                 VersionCommand::class,

src/Commands/CheckComponentsCommand.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Cachet\Commands;
+
+use Cachet\Jobs\CheckComponent;
+use Cachet\Models\Component;
+use Illuminate\Console\Command;
+
+class CheckComponentsCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'cachet:check';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Check the status of all components.';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        Component::query()
+            ->enabled()
+            ->checked()
+            ->whereNotNull('link')
+            ->get()
+            ->each(fn (Component $component) => CheckComponent::dispatch($component));
+
+        $this->components->success('Component check dispatched.');
+
+        return self::SUCCESS;
+    }
+}

src/Data/Checks/CheckResult.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Cachet\Data\Checks;
+
+use Cachet\Data\BaseData;
+use Cachet\Enums\ComponentStatusEnum;
+use Illuminate\Http\Client\ConnectionException;
+use Illuminate\Http\Client\RequestException;
+use Illuminate\Http\Client\Response;
+
+final class CheckResult extends BaseData
+{
+    public function __construct(
+        public readonly ComponentStatusEnum $status,
+        public readonly bool $successful,
+        public readonly ?int $responseCode = null,
+        public readonly ?int $responseTime = null,
+        public readonly ?string $error = null,
+    ) {}
+
+    /**
+     * Build a check result from a successful HTTP exchange.
+     */
+    public static function fromResponse(Response $response, int $attempts, ?float $transferTime = null): self
+    {
+        $status = match (true) {
+            $response->successful() && $attempts === 1 => ComponentStatusEnum::operational,
+            $response->successful() => ComponentStatusEnum::performance_issues,
+            $response->status() >= 500 => ComponentStatusEnum::major_outage,
+            $response->status() >= 400 => ComponentStatusEnum::partial_outage,
+            default => ComponentStatusEnum::operational,
+        };
+
+        return new self(
+            status: $status,
+            successful: $response->successful(),
+            responseCode: $response->status(),
+            responseTime: $transferTime !== null ? (int) round($transferTime * 1000) : null,
+        );
+    }
+
+    /**
+     * Build a check result from a failed HTTP request.
+     */
+    public static function fromException(RequestException|ConnectionException $e): self
+    {
+        $status = match (true) {
+            $e->getCode() >= 500 => ComponentStatusEnum::major_outage,
+            default => ComponentStatusEnum::partial_outage,
+        };
+
+        return new self(
+            status: $status,
+            successful: false,
+            responseCode: $e->getCode() ?: null,
+            error: $e->getMessage(),
+        );
+    }
+
+    /**
+     * The attributes used to persist this result as a component check.
+     *
+     * @return array<string, mixed>
+     */
+    public function toCheckAttributes(): array
+    {
+        return [
+            'status' => $this->status,
+            'successful' => $this->successful,
+            'response_code' => $this->responseCode,
+            'response_time' => $this->responseTime,
+        ];
+    }
+}

src/Filament/Resources/Components/ComponentResource.php

@@ -6,6 +6,7 @@
 use Cachet\Filament\Resources\Components\Pages\CreateComponent;
 use Cachet\Filament\Resources\Components\Pages\EditComponent;
 use Cachet\Filament\Resources\Components\Pages\ListComponents;
+use Cachet\Filament\Resources\Components\RelationManagers\ChecksRelationManager;
 use Cachet\Models\Component;
 use Filament\Actions\BulkActionGroup;
 use Filament\Actions\DeleteBulkAction;
@@ -58,6 +59,8 @@ public static function form(Schema $schema): Schema
                         ->label(__('cachet::component.form.link_label'))
                         ->url()
                         ->label(__('cachet::component.form.link_helper')),
+                    Toggle::make('checked')
+                        ->label(__('cachet::component.form.checked_label')),
                 ]),
 
                 Section::make()->columns(2)->schema([
@@ -98,6 +101,15 @@ public static function table(Table $table): Table
                     ->dateTime()
                     ->sortable()
                     ->toggleable(isToggledHiddenByDefault: true),
+                IconColumn::make('checked')
+                    ->label(__('cachet::component.list.headers.checked'))
+                    ->boolean()
+                    ->toggleable(isToggledHiddenByDefault: false),
+                TextColumn::make('checked_at')
+                    ->label(__('cachet::component.list.headers.checked_at'))
+                    ->dateTime()
+                    ->sortable()
+                    ->toggleable(isToggledHiddenByDefault: false),
                 TextColumn::make('updated_at')
                     ->label(__('cachet::component.list.headers.updated_at'))
                     ->dateTime()
@@ -129,7 +141,7 @@ public static function table(Table $table): Table
     public static function getRelations(): array
     {
         return [
-            //
+            ChecksRelationManager::class,
         ];
     }
 

src/Filament/Resources/Components/RelationManagers/ChecksRelationManager.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Cachet\Filament\Resources\Components\RelationManagers;
+
+use Filament\Resources\RelationManagers\RelationManager;
+use Filament\Tables\Columns\IconColumn;
+use Filament\Tables\Columns\TextColumn;
+use Filament\Tables\Table;
+
+class ChecksRelationManager extends RelationManager
+{
+    protected static string $relationship = 'checks';
+
+    public function table(Table $table): Table
+    {
+        return $table
+            ->heading(__('cachet::component.checks.title'))
+            ->modelLabel(__('cachet::component.checks.title'))
+            ->columns([
+                TextColumn::make('status')
+                    ->label(__('cachet::component.checks.headers.status'))
+                    ->badge()
+                    ->sortable(),
+                IconColumn::make('successful')
+                    ->label(__('cachet::component.checks.headers.successful'))
+                    ->boolean()
+                    ->sortable(),
+                TextColumn::make('response_code')
+                    ->label(__('cachet::component.checks.headers.response_code'))
+                    ->placeholder('—')
+                    ->sortable(),
+                TextColumn::make('response_time')
+                    ->label(__('cachet::component.checks.headers.response_time'))
+                    ->placeholder('—')
+                    ->suffix(' ms')
+                    ->sortable(),
+                TextColumn::make('checked_at')
+                    ->label(__('cachet::component.checks.headers.checked_at'))
+                    ->dateTime()
+                    ->sortable(),
+            ])
+            ->defaultSort('checked_at', 'desc')
+            ->emptyStateHeading(__('cachet::component.checks.empty_state.heading'))
+            ->emptyStateDescription(__('cachet::component.checks.empty_state.description'));
+    }
+}