Skip to content
Capell CMS

Exception Reports

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/exception-reports
Package slug exception-reports
Product group Capell Operations
Tier free
Bundle operations
Runtime contexts console, shared
Capell version ^1.0
Catalogue role extension
Release channel Labs
Source repository capell-app/packages
Source path packages/exception-reports
Docs source packages/exception-reports/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Exception Reports is an Available, No schema impact Capell package in the Capell Operations product group. It ships as capell-app/exception-reports and extends these surfaces: console, shared.

Exception Reports queues sanitized unhandled-exception reports to configured email recipients and optional signed webhook endpoints, with rate limiting and grouped digests.

Operators receive a sanitized email or webhook payload for triage. The package has no admin resource; recipients, privacy options, and delivery behavior are configured at application level.

Evidence: capell.json, config/capell-exception-reports.php, src/Actions/ReportExceptionByEmailAction.php, src/Actions/SendExceptionReportWebhookAction.php, docs/screenshots.json, src/Mail/UnhandledExceptionReported.php.

Status details:

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

Why It Matters

Section titled “Why It Matters”

For developers: A typed report boundary and sanitizer keep request secrets out of queued payloads, while trace, identity, IP, and route-parameter details remain opt-in.

For teams: Operational failures reach the configured owner with enough context to start triage, and repeated signatures can be rate limited or summarized instead of producing duplicate alerts.

Evidence: src/Data/ExceptionReportData.php, src/Support/ExceptionReportMailSanitizer.php, config/capell-exception-reports.php, tests/Feature/ExceptionEmailReportingTest.php, src/Actions/QueueRateLimitedExceptionDigestAction.php, src/Providers/ExceptionReportsServiceProvider.php, tests/Feature/Health/ExceptionReportsHealthCheckTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Exception Reports extension card

  • Exception Reports extension card (marketplace, required).
  • Exception Reports rendered email preview remains diagnostic-only until a route-backed package fixture has a matching runner receipt.

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\ExceptionReports\Providers\ExceptionReportsServiceProvider.
  • Config files: packages/exception-reports/config/capell-exception-reports.php.
  • Actions: QueueRateLimitedExceptionDigestAction, ReportExceptionByEmailAction, SendExceptionReportWebhookAction.
  • Data objects: ExceptionReportData, ResolvedExceptionReportWebhookEndpointData.
  • Manifest action API: reportExceptionByEmail: Capell\ExceptionReports\Actions\ReportExceptionByEmailAction.
  • Manifest contributions: health-check: Capell\ExceptionReports\Health\ExceptionReportsHealthCheck.
  • Health checks: Capell\ExceptionReports\Health\ExceptionReportsHealthCheck.
  • Blade views: packages/exception-reports/resources/views/mail/reported.blade.php.

Data Model

Section titled “Data Model”

This package has no schema impact. It extends Capell through health-check contributions instead of declaring package-owned tables.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/core.
  • Admin navigation: no admin page or resource contribution is declared.
  • Admin/editor extensions: none declared.
  • Permissions: none declared in capell.json.
  • Public routes: none declared.
  • Database changes: no package migrations declared.
  • Config: config/capell-exception-reports.php.
  • Settings: no package settings declared.
  • Queues or schedules: none declared.
  • Cache tags: none declared.
  • Commands: none declared.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/core.
  • Review package configuration before production-like verification: config/capell-exception-reports.php.

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

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/exception-reports.
  2. Review config/capell-exception-reports.php before enabling the package.
  3. Open the package detail or install-intent surface and confirm the Exception Reports extension card is present.

Next Steps

Section titled “Next Steps”