Storage Monitor

• Requirements
• Installation
• Usage
  • Adding Disks
    • Manual Registration
    • Laravel Disk Registration
  • Authorization & Visibility
  • Compact Mode
  • Widget Properties
  • Strict Mode
• Localization
• License
• Contributing
• Support

A strictly typed, highly expressive Filament plugin to monitor server storage. This package provides a clean, native-feeling dashboard widget that displays disk usage with support for multiple partitions, custom labeling, and dynamic health-based coloring.

#Requirements

• PHP: 8.2+
• Filament: 4.x or 5.x

#Installation

You can install the package via Composer:

composer require achyutn/filament-storage-monitor

Register the plugin inside your Filament panel:

use AchyutN\FilamentStorageMonitor\FilamentStorageMonitor;

return $panel
    ->plugins([
        FilamentStorageMonitor::make()
            ->addDisk('/mnt/data', label: 'Data Partition')
            ->laravelDisk(name: 'public', label: 'Media Storage'),
    ]);

You can chain several methods to customize the widget's behavior and appearance:

FilamentStorageMonitor::make()
    ->addDisk(path: '/', label: 'Root Storage')
    ->columnSpan('full')
    ->sort(-3)
    ->lazy(false)
    ->visible(fn () => auth()->user()->isAdmin()),

#Usage

The plugin automatically registers a dashboard widget once disks are configured.

#Adding Disks

You can add disks manually by providing a path, or resolve them directly from your Laravel filesystem configuration.

#Manual Registration

You can either use addDisk() for adding a disk through parameters or add() using the Disk DTO:

use AchyutN\FilamentStorageMonitor\DTO\Disk;
use AchyutN\FilamentStorageMonitor\FilamentStorageMonitor;
use Filament\Support\Colors\Color;
use Filament\Support\Icons\Heroicon;

FilamentStorageMonitor::make()
    ->add(
        Disk::make('web-root')
            ->path('/var/www/html')
            ->label('Web Root')
            ->color(Color::Green)
            ->icon(Heroicon::ComputerDesktop),
    )
    ->addDisk(
        path: '/mnt/backup',
        label: 'Backups',
        color: Color::Blue,
        icon: Heroicon::ArchiveBox,
    );

#Laravel Disk Registration

You can also register disks directly from your Laravel filesystem configuration file config/filesystems.php:

FilamentStorageMonitor::make()
    ->laravelDisk(name: 'local', label: 'Local Storage');

#Authorization & Visibility

You can control the visibility of the entire widget or individual disks using boolean values or closures. This is useful for restricting sensitive server information to administrators.

FilamentStorageMonitor::make()
    ->visible(fn () => auth()->user()->is_admin) // Hide entire widget
    ->addDisk(
        path: '/var/www/html', 
        label: 'App Files',
        isVisible: fn () => auth()->user()->can('view_server_stats') // Hide specific disk
    );

#Compact Mode

If you want a minimal display that only shows the disk label and free space, you can enable compact mode:

FilamentStorageMonitor::make()
    ->compact();

#Widget Properties

• columnSpan(): Set the widget's column span (e.g., 'full', 'half', or a specific number).
• columnStart(): Define the starting column for the widget.
• sort(): Define the widget's order on the dashboard (lower numbers appear first).
• lazy(): Enable or disable lazy loading of the widget (default is true).
• visible(): Control the widget's visibility with a boolean or closure.

#Strict Mode

By default, if a disk path cannot be resolved or is misconfigured (e.g., a missing mount), the widget will not crash your Filament panel. Instead, it gracefully catches the error.

If you prefer exceptions to be thrown when a disk is missing or has errors, you can enable throwException() mode:

FilamentStorageMonitor::make()
    ->throwException(true) // boolean

// or

FilamentStorageMonitor::make()
    ->throwException(fn () => app()->isLocal()) // Closure

[!NOTE] This package currently monitors Disk Partitions using native PHP filesystem functions. If you add two different paths that reside on the same partition (e.g., /var/www/html and /var/www/html/laravel-project), they will display the same total/free space because they belong to the same filesystem boundary.

Directory-specific size calculation is planned for a future release.

#Localization

Filament Storage Monitor includes built-in translations for:

• English

Translations are applied automatically based on your application's current locale.

Missing your language? Feel free to submit a PR to add it!

#License

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

#Contributing

Contributions are welcome! Please create a pull request or open an issue if you find any bugs or have feature requests.

#Support

If you find this package useful, please consider starring the repository on GitHub to show your support.