Download the PHP package upgradelabs/sentinel-laravel without Composer

Sentinel Laravel

Error reporting client for Sentinel. Captures exceptions from your Laravel application and sends them to your Sentinel dashboard.

Compatible with Laravel 8, 9, 10, 11, 12, and 13.

Installation

Configuration

Add your Sentinel API token to .env:

That's it. Sentinel will automatically capture and report unhandled exceptions.

The token identifies your project — you get it when creating a project on the Sentinel dashboard or via php artisan sentinel:create-project on the Sentinel server.

Publish config (optional)

Optional Configuration

Report only from specific environments

Send reports via queue (recommended for production)

Disable reporting

Heartbeat (automatic)

Sentinel pings the dashboard every 5 minutes to report your app is alive. This powers the status page. It's enabled by default — requires the Laravel scheduler to be running:

To disable:

Ignored exceptions

Edit config/sentinel.php to customize which exceptions are ignored:

Manual Reporting

You can manually report exceptions:

Laravel 8/9 (Manual Handler Setup)

For older Laravel versions where automatic reportable() registration may not work, add the trait to your exception handler:

What Gets Reported

Each error report includes:

• Exception class, message, file, line
• Full stack trace
• Severity (auto-detected: fatal, error, warning, notice)
• Laravel & PHP version
• Environment (production, staging, local, etc.)
• Request data (URL, method, headers, input — sensitive fields redacted)
• Authenticated user (id, email, name)
• Previous exception chain
• Custom context (order_id, payment_method, etc.)
• Breadcrumbs (DB queries, cache, jobs — sequence of events before the error)
• Performance (request duration, memory usage — when middleware is active)

Data Privacy

Sensitive fields are automatically redacted from request data:

• password, password_confirmation
• token, secret
• credit_card, card_number, cvv, ssn
• Authorization, Cookie, and CSRF headers

Deploy Tracking

Notify Sentinel when you deploy so you can correlate errors with releases.

Artisan command (recommended)

All flags are optional. Use --auto to detect tag (from git tag), commit hash, and branch automatically.

In CI/CD pipelines

GitHub Actions:

Laravel Forge / Envoyer (deploy script):

Or with curl (no package needed):

Programmatic usage

Context Enrichment

Add custom context that gets attached to any error that occurs during the request:

Breadcrumbs

Breadcrumbs automatically track the sequence of events leading up to an error. Enabled by default.

Auto-captured events:

• Database queries (SQL, time, connection)
• Cache hits and misses
• Queue job processing

Add manual breadcrumbs:

Configure in config/sentinel.php:

Performance Tracking

Track request duration and memory usage by adding the middleware:

Performance data (duration_ms, memory_peak_mb) is automatically included in error reports.

Log Channel

Send Laravel log entries to Sentinel by adding a custom log channel:

Then use it alongside your default channel:

Read API

Pull data from Sentinel for external tools (Grafana, custom dashboards):

Testing

Verify configuration

Test error reporting

Test heartbeat

Send a manual heartbeat to verify your app shows as "Online" on the Sentinel status page:

Or test with curl using your project's API token:

Once a heartbeat is received, your project shows as Online on the status page. If no heartbeat is received for 10+ minutes, it switches to Offline and a critical alert email is sent.

With the scheduler running (* * * * * php artisan schedule:run), heartbeats are sent automatically every 5 minutes — no manual work needed.

License

MIT