Skip to content
Capell CMS

Diagnostics

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

Field Value
Composer package capell-app/diagnostics
Package slug diagnostics
Product group Capell Operations
Tier free
Bundle operations
Runtime contexts admin, console
Capell version ^1.0
Catalogue role extension
Release channel Beta
Source repository capell-app/packages
Source path packages/diagnostics
Docs source packages/diagnostics/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Diagnostics is an Available, Schema-owning Capell package in the Capell Operations product group. It ships as capell-app/diagnostics and extends these surfaces: admin, console.

Diagnostics adds package, configuration, cache, content, permission, and queue health reporting plus a guarded command palette for trusted operations.

Operators inspect health widgets and focused report pages, investigate queue failures, and run permitted diagnostic commands with recorded parameters and output.

Evidence: capell.json, src/Providers/DiagnosticsServiceProvider.php, src/Filament/Pages/SystemHealthPage.php, src/Contracts/CommandPaletteProvider.php, docs/overview.admin.md, docs/screenshots.json, src/Filament/Pages/QueueHealthPage.php, tests/Feature/Filament/Pages/CommandPalettePageTest.php.

Status details:

  • Status: Available
  • Tier: free
  • Bundle: operations
  • Composer package: capell-app/diagnostics
  • Namespace: Capell\Diagnostics
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Each health signal and command operation is isolated in an Action or provider, including parameter validation and output redaction before a run is stored.

For teams: Teams get a shared view of operational problems and enough context to route content, configuration, permission, or queue issues to the right owner.

Evidence: src/Actions/CommandPalette/ValidateCommandPaletteParametersAction.php, src/Actions/CommandPalette/RedactCommandPaletteOutputAction.php, src/Actions/CommandPalette/ExecuteCommandPaletteCommandAction.php, tests/Feature/Actions/CommandPaletteActionsTest.php, docs/admin-guide.md, src/Actions/Dashboard/BuildConfigDriftAction.php, src/Actions/DashboardReports/BuildPermissionAuditQueryAction.php, src/Actions/DashboardReports/BuildQueueHealthQueryAction.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Illustrative developer tools dashboard preview Illustrative developer tools dashboard preview Site health widget on the admin dashboard Site health widget on the admin dashboard
  • Illustrative developer tools dashboard preview (frontend, required evidence).
  • Site health widget on the admin dashboard (admin, required evidence).
  • Command palette page (admin, required evidence).
  • System health page (admin, required evidence).
  • Permission audit page (admin, required evidence).
  • Queue Operations page (admin, required evidence).
  • Command palette page with admin sidebar menu open (admin, supplementary evidence).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\Diagnostics\Providers\DiagnosticsServiceProvider, Capell\Diagnostics\Providers\AdminServiceProvider.
  • Config files: packages/diagnostics/config/capell-diagnostics.php.
  • Migrations: packages/diagnostics/database/migrations/2026_05_10_190846_01_create_command_palette_runs_table.php, packages/diagnostics/database/migrations/2026_05_29_000001_create_queue_monitors_table.php, packages/diagnostics/database/migrations/2026_06_07_000001_create_diagnostics_health_snapshots_table.php, packages/diagnostics/database/migrations/2026_07_10_000001_encrypt_command_palette_parameters.php.
  • Models: CommandPaletteRun, DiagnosticsHealthSnapshot, FailedJob, PendingQueueJob, QueueMonitor.
  • Filament classes: CommandPalettePage, DiagnosticsPage, PermissionAuditPage, QueueHealthPage, SystemHealthPage, PermissionAuditTable, QueueHealthTable, AlertsFilamentWidget, CacheHealthFilamentWidget, ConfigDriftFilamentWidget, ContentGraphHealthFilamentWidget, ContentHealthFilamentWidget, and 7 more.
  • Extension contracts: CommandPaletteProvider.
  • Actions: DiscoverCommandPaletteCommandsAction, ExecuteCommandPaletteCommandAction, PruneCommandPaletteRunsAction, RedactCommandPaletteOutputAction, ValidateCommandPaletteParametersAction, BuildCacheHealthAction, BuildConfigDriftAction, BuildContentGraphHealthAction, BuildMigrationsHealthAction, BuildPackagesInstalledAction, BuildRegistryHealthAction, BuildSetupHealthAction, and 19 more.
  • Data objects: CommandPaletteCommandData, CommandPaletteParameterData, CommandPaletteResultData, CacheHealthData, ConfigDriftData, ConfigDriftEntryData, ContentGraphHealthData, ContentHealthData, ContentHealthIssueData, MigrationsHealthData, PackageInfoData, PackagesInstalledData, and 16 more.
  • Jobs: RunCommandPaletteArtisanJob.
  • Command signatures: capell:diagnostics:health, capell:diagnostics:prune.
  • Manifest action API: buildCacheHealth: Capell\Diagnostics\Actions\Dashboard\BuildCacheHealthAction, buildConfigDrift: Capell\Diagnostics\Actions\Dashboard\BuildConfigDriftAction, buildExtensionHealthTrend: Capell\Diagnostics\Actions\Health\BuildExtensionHealthTrendAction, buildInfrastructureStatus: Capell\Diagnostics\Actions\DashboardReports\BuildInfrastructureStatusAction, buildMigrationsHealth: Capell\Diagnostics\Actions\Dashboard\BuildMigrationsHealthAction, buildPackagesInstalled: Capell\Diagnostics\Actions\Dashboard\BuildPackagesInstalledAction, buildPermissionAuditQuery: Capell\Diagnostics\Actions\DashboardReports\BuildPermissionAuditQueryAction, buildPublicOutputSafetyReport: Capell\Diagnostics\Actions\DashboardReports\BuildPublicOutputSafetyReportAction, buildQueueHealthQuery: Capell\Diagnostics\Actions\DashboardReports\BuildQueueHealthQueryAction, buildQueueOperationsStats: Capell\Diagnostics\Actions\DashboardReports\BuildQueueOperationsStatsAction, buildRegistryHealth: Capell\Diagnostics\Actions\Dashboard\BuildRegistryHealthAction, buildSetupHealth: Capell\Diagnostics\Actions\Dashboard\BuildSetupHealthAction, and 7 more.
  • Scheduled commands: capell:diagnostics:prune (daily; manifest declared).
  • Console command classes: PruneDiagnosticsHistoryCommand, RunDiagnosticsHealthCommand.
  • Manifest contributions: admin-page: Capell\Diagnostics\Manifest\CommandPalettePageContribution, admin-page: Capell\Diagnostics\Manifest\DiagnosticsPageContribution, admin-page: Capell\Diagnostics\Manifest\PermissionAuditPageContribution, admin-page: Capell\Diagnostics\Manifest\QueueHealthPageContribution, admin-page: Capell\Diagnostics\Manifest\SystemHealthPageContribution, dashboard-widget: Capell\Diagnostics\Manifest\SiteHealthWidgetContribution, dashboard-widget: Capell\Diagnostics\Manifest\SystemHealthWidgetsContribution, scheduled-job: Capell\Diagnostics\Manifest\DiagnosticsRetentionScheduleContribution.
  • Health checks: Capell\Diagnostics\Health\DiagnosticsHealthCheck.
  • Blade views: packages/diagnostics/resources/views/filament/pages/command-palette.blade.php, packages/diagnostics/resources/views/filament/pages/diagnostics.blade.php, packages/diagnostics/resources/views/widgets/cache-health.blade.php, packages/diagnostics/resources/views/widgets/config-drift.blade.php, packages/diagnostics/resources/views/widgets/content-graph-health.blade.php, packages/diagnostics/resources/views/widgets/content-health.blade.php, packages/diagnostics/resources/views/widgets/migrations-health.blade.php, packages/diagnostics/resources/views/widgets/packages-installed.blade.php, packages/diagnostics/resources/views/widgets/registry-health.blade.php, packages/diagnostics/resources/views/widgets/setup-health.blade.php, packages/diagnostics/resources/views/widgets/site-health.blade.php, packages/diagnostics/resources/views/widgets/tailwind-build-status.blade.php.
  • Cache tags: diagnostics.

Data Model

Section titled “Data Model”
  • Required tables: command_palette_runs, queue_monitors, diagnostics_health_snapshots.
  • Models: CommandPaletteRun, DiagnosticsHealthSnapshot, FailedJob, PendingQueueJob, QueueMonitor.
  • Core record references in migrations: users via user_id.
  • Migration files: 2026_05_10_190846_01_create_command_palette_runs_table.php, 2026_05_29_000001_create_queue_monitors_table.php, 2026_06_07_000001_create_diagnostics_health_snapshots_table.php, 2026_07_10_000001_encrypt_command_palette_parameters.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare null-on-delete relationships; retention is scheduled through capell:diagnostics:prune (daily; declared in the manifest).

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/html-cache.
  • Admin navigation: declares admin-page: CommandPalettePageContribution, admin-page: DiagnosticsPageContribution, admin-page: PermissionAuditPageContribution, admin-page: QueueHealthPageContribution, admin-page: SystemHealthPageContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: dashboard-widget: SiteHealthWidgetContribution, dashboard-widget: SystemHealthWidgetsContribution.
  • Permissions: View:DiagnosticsPage, Execute:DiagnosticsPage, View:PermissionAuditPage, View:CommandPalettePage, Execute:CommandPalettePage, View:SystemHealthPage, View:QueueHealthPage, Execute:QueueHealthPage, Delete:QueueHealthPage.
  • Public routes: none declared.
  • Database changes: package migrations are declared.
  • Config: config/capell-diagnostics.php.
  • Settings: no package settings declared.
  • Queues or schedules: scheduled commands capell:diagnostics:prune (daily; manifest declared); queue jobs RunCommandPaletteArtisanJob.
  • Cache tags: diagnostics.
  • Commands: capell:diagnostics:health, capell:diagnostics:prune.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/html-cache.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-diagnostics.php.
  • Keep the host Laravel scheduler running so package-registered schedules can execute: capell:diagnostics:prune (daily; manifest declared).
  • Custom write integrations must preserve invalidation for diagnostics cache tags.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Check Fix
Package surface is missing after install Provider or manifest is not loaded Confirm capell.json, package composer.json, and provider registration Reinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing table Package migrations have not run Check the tables listed in Data Model Run host migrations and rerun the focused package test
Background work does not run Queue worker or declared schedule is not active Check the jobs and scheduled commands listed in Technical Shape Start the queue worker or host scheduler, then run the focused command or package test

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/diagnostics.
  2. Run the required setup: php artisan migrate.
  3. Open the package admin surface at /admin and confirm Diagnostics is available.

Next Steps

Section titled “Next Steps”