README.md

A Laravel Pulse card displaying the table info of the current database.

This pulse card displays the tables in the database with their corresponding info (size and rows).

Installation

You can install the package via composer:

composer require schmeits/pulse-database-table-info

Register the recorder

To run the checks you must add the TableInfoRecorder to the pulse.php file.

return [
    // ...
    
    'recorders' => [
+        \Schmeits\Pulse\DatabaseTableInfo\Recorders\TableInfoRecorder::class => [],
    ]
]

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

Configure the recorder

\Schmeits\Pulse\DatabaseTableInfo\Recorders\TableInfoRecorder::class => [
    'enabled' => env('PULSE_DATABASE_TABLE_ENABLED', true), // ebabling the recorder
    'ignore' => [
        '#^pulse#', // Ignore pulse entries...
        '#^telescope#', // Ignore telescope entries...
        '#^health_check_result#', // ignore health_check_results
    ],
],

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.table-info cols='4' rows='2' />

    <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>

That's it :)

Testing

composer test

Changelog

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

Credits

• Tally Schmeits
• All Contributors

License

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