AppPulse

A comprehensive, easy-to-use monitoring tool with uptime tracking, SSL certificate checks, and customizable notifications designed for Laravel applications.

AppPulse allows developers to monitor websites efficiently by:

• Tracking website uptime and logging response times.
• Validating SSL certificates and sending alerts when expiry is near.

---

Installation

1. Install the Package

You can install AppPulse via Composer:

composer require cleaniquecoders/app-pulse

---

2. Publish Configuration & Migrations

Run the following commands to publish the configuration and migration files:

php artisan vendor:publish --tag="app-pulse-config"
php artisan vendor:publish --tag="app-pulse-migrations"

This will generate the config file at:

config/app-pulse.php

Example config:

return [
    'events' => [
        \CleaniqueCoders\AppPulse\Events\MonitorUptimeChanged::class => [],
        \CleaniqueCoders\AppPulse\Events\SslStatusChanged::class => [],
    ],
    'scheduler' => [
        'interval' => env('APP_PULSE_SCHEDULER_INTERVAL', 10), // Minutes between checks
        'queue' => env('APP_PULSE_SCHEDULER_QUEUE', 'default'), // Queue to use
        'chunk' => env('APP_PULSE_SCHEDULER_CHUNK', 100), // Monitors per batch
    ],
];

Next, run the migrations to create the necessary database tables:

php artisan migrate

---

3. Set Up Laravel Scheduler

Ensure that Laravel’s scheduler is running. Add the following cron entry to your server to run the scheduler every minute:

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

The monitor checks will now run at intervals defined in config/app-pulse.php (default: every 10 minutes).

---

Usage Example

1. Adding Monitors

Use the following logic to create a new monitor record in your application:

use CleaniqueCoders\AppPulse\Models\Monitor;

$monitor = Monitor::create([
    'owner_type' => \App\Models\User::class, // Owner model type
    'owner_id' => 1, // Owner ID (e.g., User or Application)
    'url' => 'https://example.com', // URL to monitor
    'interval' => 10, // Interval (in minutes) between checks
    'ssl_check' => true, // Enable or disable SSL check
]);

---

2. Running Checks Manually

You can trigger all monitor checks manually with the following command:

php artisan monitor:check-status

---

3. Automated Checks with Scheduler

1. Ensure Laravel’s scheduler is configured to run every minute on your server:

   * * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

2. The AppPulse scheduler will run every X minutes, as defined in the config/app-pulse.php:

   'scheduler' => [
       'interval' => env('APP_PULSE_SCHEDULER_INTERVAL', 10), // Run every 10 minutes
       'queue' => env('APP_PULSE_SCHEDULER_QUEUE', 'default'), // Queue to use
       'chunk' => env('APP_PULSE_SCHEDULER_CHUNK', 100), // Process monitors in batches
   ],

3. When the scheduler runs, it will:

   • Dispatch a CheckMonitorJob to check uptime.
   • Dispatch a CheckSslJob if SSL monitoring is enabled.

---

4. Handling Events

Developers can extend AppPulse by listening to the following events:

• MonitorUptimeChanged: Fired when a monitor’s uptime status changes.
• SslStatusChanged: Fired when a monitor's SSL status changes.

Example Event Listener Registration (in EventServiceProvider):

protected $listen = [
    \CleaniqueCoders\AppPulse\Events\MonitorUptimeChanged::class => [
        \App\Listeners\HandleUptimeChange::class,
    ],
    \CleaniqueCoders\AppPulse\Events\SslStatusChanged::class => [
        \App\Listeners\HandleSslStatusChange::class,
    ],
];

---

Testing

Run the tests with:

composer test

---

Changelog

See CHANGELOG for recent changes.

---

Contributing

Please see CONTRIBUTING for details on contributing.

---

Security Vulnerabilities

For security concerns, review our security policy.

---

Credits

• Nasrul Hazim Bin Mohamad
• All Contributors

---

License

This package is open-sourced software licensed under the MIT License.