https://github.com/bezhansalleh/filament-exceptions

A Simple & Beautiful Pluggable Exception Viewer for FilamentPHP's Admin Panel
https://github.com/bezhansalleh/filament-exceptions

exception-reporter exception-viewer filamentadmin filamentphp laravel plugin

Last synced: 7 days ago
JSON representation

A Simple & Beautiful Pluggable Exception Viewer for FilamentPHP's Admin Panel

• Host: GitHub
• URL: https://github.com/bezhansalleh/filament-exceptions
• Owner: bezhanSalleh
• License: mit
• Created: 2022-09-04T05:40:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T16:31:18.000Z (about 2 months ago)
• Last Synced: 2024-10-29T10:48:12.612Z (about 2 months ago)
• Topics: exception-reporter, exception-viewer, filamentadmin, filamentphp, laravel, plugin
• Language: PHP
• Homepage:
• Size: 156 KB
• Stars: 152
• Watchers: 4
• Forks: 22
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-laravel-filament - Other - Exception Handling
• awesome-laravel-filament - Other - Exception Handling

README

        








    

        

    

    

        

    

    

        

    

    

        

    



    

    



# Exception Viewer

A Simple & Beautiful Exception Viewer for FilamentPHP's Admin Panel

* For FilamentPHP 2.x use version 1.x

## Installation

1. You can install the package via composer:

```bash

composer require bezhansalleh/filament-exceptions

```

2. Publish and run the migration via:

```bash

php artisan exceptions:install

```

3. Register the plugin for the Filament Panel

```php

public function panel(Panel $panel): Panel

{

    return $panel

        ->plugins([

            \BezhanSalleh\FilamentExceptions\FilamentExceptionsPlugin::make()

        ]);

}

```

4. Activate the plugin by editing your App's Exception Handler as follow:

```php

reportable(function (Throwable $e) {

            if ($this->shouldReport($e)) {

                FilamentExceptions::report($e);

            }

        });

        ...

    }

```

## Configuration

The configuration file filament-exceptions.php is automatically published into your config directory.

The config file provides you with multiple options to customize the plugin.

### Mass Pruning

By default Filament Exceptions is configured to prune exceptions older than 1 week.

To modify how long you'd like to store records for you can supply a Carbon object like so

```php

'period' => now()->subWeek(), // 1 week

'period' => now()->subDay(), // 1 day

'period' => now()->subDays(3), // 3 days

```

> **Note** This requires laravel scheduler to be setup and configured in order to work. You can see how to do that here  [Running The Scheduler](https://laravel.com/docs/10.x/scheduling#running-the-scheduler)

 

### Custom Exception Model

For those who need to change the model this is possible using the configuration file.

```php

    'exception_model' => Exception::class,

```

When creating your new exception model you should extend the default model

```php