vcian/pulse-docker-monitor

A Laravel Pulse card to show docker containers with CPU & Memory Utilization

v1.0.0 2024-01-04 09:27 UTC

This package is auto-updated.

Last update: 2024-11-22 10:51:26 UTC


README

Packagist License (custom server) Packagist Downloads (custom server)

Docker Monitor Card For Laravel Pulse

About

This card will monitor your docker containers and show container statistics with Cpu & Memory Load.


Docker Monitor Card

Installation


Prerequisites

Please check the official laravel installation guide for server requirements before you start. [Official Documentation]

Require the package with Composer:

composer require vcian/pulse-docker-monitor

Next, you should publish the Pulse configuration and migration files using the vendor:publish Artisan command:

php artisan vendor:publish --provider="Laravel\Pulse\PulseServiceProvider"

Next, you should run the migration for required tables

php artisan migrate

Register the recorder

Right now, the Composer dependencies will only be checked once per day. To run the checks you must add the PulseDockerMonitorRecorder to the pulse.php file.

return [
    // ...
    
    'recorders' => [
+        \Vcian\Pulse\PulseDockerMonitor\Recorders\PulseDockerMonitorRecorder::class => [],
    ]
]

You also need to be running the pulse:check command.

Add to your dashboard

To add the card to the Pulse dashboard, you must first [publish the vendor view]

Then, you can modify the dashboard.blade.php file:

<x-pulse>
+     <livewire:pulse_docker_monitor cols="full" />

    <livewire:pulse.servers cols="full" />

    <livewire:pulse.usage cols="4" rows="2" />

    <livewire:pulse.queues cols="4" />

    <livewire:pulse.cache cols="4" />

    <livewire:pulse.slow-queries cols="8" />

    <livewire:pulse.exceptions cols="6" />

    <livewire:pulse.slow-requests cols="6" />

    <livewire:pulse.slow-jobs cols="6" />

    <livewire:pulse.slow-outgoing-requests cols="6" />

</x-pulse>

To make pulse recorders will automatically capture entries based on framework events dispatched by Laravel, You must run the below command.

php artisan pulse:check

Security

If you discover any security-related issues, please email ruchit.patel@viitor.cloud instead of using the issue tracker.

Credits

License

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