Download the PHP package nazirul-amin/sentinel-actor without Composer

Sentinel Actor

This package provides a simple way to monitor your application by sending exception data to a webhook endpoint. It includes traits and utilities to automatically send exception information from jobs, notifications, and other parts of your application. Compatible with PHP 8.1+ and Laravel 10+.

Installation

You can install the package via composer (compatible with PHP 8.1+ and Laravel 10+):

You can publish the config file with:

This is the contents of the published config file:

Configuration

Add the following environment variables to your .env file:

HMAC Signature Verification

This package supports HMAC signature verification for enhanced security. When you configure a secret in your .env file, all outgoing webhook requests will be signed with HMAC-SHA256.

The receiving service can verify the authenticity of the request by comparing the signature in the Sentinel-Signature header with a locally computed signature using the same secret.

Usage

Monitoring Exceptions in Jobs

To automatically send exception data from your jobs, simply use the MonitorsExceptions trait:

Monitoring Exceptions in Notifications

Similarly, you can monitor exceptions in notifications:

Application Health Status Monitoring

To send application health status updates (active/inactive), use the UpdatesApplicationStatus trait:

Scheduled Health Checks

The package includes a built-in health check command that can be scheduled to run periodically:

This command performs basic health checks and sends the status to your monitoring service. You can customize the health checks by extending the command.

Manual Exception Monitoring

You can also manually send exception data using the facade:

Sending Custom Events

You can also send custom events to your monitoring service:

Webhook Payload Structure

All webhooks sent by this package include the following data:

Exception Webhooks

• application_id: The application identifier from config
• application_version: The application version from config
• environment: The current Laravel environment (local, production, staging, etc.)
• type: Set to 'exception'
• message: The exception message
• file: The file where the exception occurred
• line: The line number where the exception occurred
• timestamp: Unix timestamp when the exception occurred
• code: The exception code
• trace: The full exception trace
• context: Additional context information

Health Status Webhooks

• application_id: The application identifier from config
• application_version: The application version from config
• environment: The current Laravel environment (local, production, staging, etc.)
• type: Set to 'health_status'
• status: Either 'active' or 'inactive'
• healthy: Boolean value indicating health status (true/false)
• message: Optional message describing the health status
• timestamp: Unix timestamp when the health status was sent
• context: Additional context information

Status Update Webhooks (Legacy)

• application_id: The application identifier from config
• application_version: The application version from config
• environment: The current Laravel environment (local, production, staging, etc.)
• type: Set to 'status_update'
• status: The status being reported (e.g., 'running', 'stopped', 'maintenance')
• message: Optional message describing the status
• timestamp: Unix timestamp when the status update was sent
• context: Additional context information

All requests are signed with HMAC-SHA256 for security.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• nazirulamin
• All Contributors

License

The MIT License (MIT). Please see License File for more information.