Filament Sentry Feedback Laravel Package

Technical Evaluation

Architecture Fit

• FilamentPHP Alignment: The package is a Filament-specific extension, meaning it tightly integrates with Filament’s admin panel ecosystem (e.g., widgets, resource panels, or dashboard plugins). This makes it ideal for projects already using FilamentPHP (v3.x+) for admin interfaces, as it leverages Filament’s built-in UI components (e.g., Widget, Panel) to embed Sentry’s feedback widget seamlessly.
• Sentry User Feedback Compatibility: The package wraps Sentry’s User Feedback SDK, which is designed for lightweight, frontend-based issue reporting. This is a low-overhead solution for collecting user-reported bugs without requiring backend processing for each submission.
• Modularity: The package follows Laravel’s service provider pattern, allowing for configuration via config/filament-sentry-feedback.php (if published). This enables customization of Sentry DSN, widget appearance, and translation keys without modifying core logic.
• Limitation: The package does not handle backend processing of feedback (e.g., storing in a database or triggering workflows). This is intentional—Sentry’s SDK handles this, but TPMs must ensure their Sentry setup (e.g., projects, issues API) is configured to receive and process feedback.

Integration Feasibility

• Prerequisites:
  • FilamentPHP v3.x+: Mandatory, as the package uses Filament’s widget system.
  • Sentry Account: Requires a Sentry organization/project with the User Feedback feature enabled (paid tier).
  • Frontend Environment: The widget is client-side JavaScript, so it must be compatible with the frontend stack (e.g., Vite, Laravel Mix, or Inertia.js if used).
• Laravel Version: Compatible with Laravel 10.x/11.x (assuming Filament’s support). No breaking changes expected if Filament remains stable.
• Database/Backend Impact: None. The package only injects a JavaScript snippet into Filament’s frontend. Feedback is sent directly to Sentry’s API.

Technical Risk

• Dependency Risk:
  • FilamentPHP: If Filament undergoes major UI changes (e.g., widget system overhaul), the package may require updates. Monitor Filament’s release notes.
  • Sentry SDK: Relies on Sentry’s frontend SDK. Breaking changes in Sentry’s API could require package updates.
• Configuration Risk: Misconfigured Sentry DSN or widget settings (e.g., incorrect project ID) could lead to feedback not being captured. Test thoroughly in staging.
• Frontend Conflicts: If the project uses custom JavaScript bundling (e.g., Webpack aliases, global variables), the Sentry script injection might conflict. Test in a staging environment.
• No Backend Processing: If the team needs to store feedback locally (e.g., for compliance or analytics), additional logic (e.g., a Laravel model + webhook) is required, which this package does not provide.

Key Questions for TPM

1. Sentry Setup:
   • Is the Sentry project/DSN already configured for User Feedback? If not, what’s the timeline to enable it?
   • Are there existing workflows (e.g., Slack alerts, Jira tickets) for Sentry issues that need to accommodate this feedback?
2. Filament Usage:
   • Where in the Filament UI should the feedback widget appear? (e.g., global widget, resource-specific panel)
   • Are there custom Filament themes or CSS that might conflict with the widget’s styling?
3. Data Handling:
   • Does the team need to archive feedback locally? If so, will a separate solution (e.g., Laravel model + Sentry webhook) be required?
4. Testing:
   • How will feedback submissions be validated in staging? (e.g., mock Sentry responses, log verification)
5. Scaling:
   • Will this be deployed across multiple Filament instances (e.g., multi-tenant)? If so, how will Sentry DSN/environment variables be managed?
6. Alternatives:
   • Has the team considered other feedback tools (e.g., Laravel Feedback, Bugsnag, or custom solutions)? What were the trade-offs?

Integration Approach

Stack Fit

• Primary Fit:
  • FilamentPHP v3.x+: The package is a first-class citizen in Filament’s ecosystem, designed to integrate with Filament’s widget system. Ideal for projects using Filament for admin dashboards.
  • Laravel 10/11: No known conflicts with modern Laravel versions.
  • Frontend: Works with Laravel’s default Vite setup or Inertia.js. For custom frontend setups (e.g., React/Vue), verify JavaScript injection compatibility.
• Secondary Fit:
  • Sentry Users: Requires a Sentry account with User Feedback enabled. Not suitable for teams without Sentry.
  • Lightweight Feedback Needs: Best for low-volume, user-initiated feedback (e.g., "Report a Bug" button). Not ideal for high-throughput or structured data collection.
• Non-Fit:
  • Non-Filament Projects: Cannot be used outside Filament’s admin panel.
  • Backend-Only Feedback: If feedback requires server-side processing (e.g., validation, storage), this package alone is insufficient.

Migration Path

1. Prerequisites Check:
   • Verify FilamentPHP version (composer show filament/filament).
   • Confirm Sentry User Feedback is enabled in the target project.
2. Installation:

   composer require martinpetricko/filament-sentry-feedback
   

3. Configuration:
   • Publish config (if customization needed):

     php artisan vendor:publish --tag="filament-sentry-feedback-config"
     

   • Update .env with Sentry DSN:

     SENTRY_FEEDBACK_DSN=your_dsn_here
     

   • Configure widget placement in config/filament-sentry-feedback.php (e.g., widget class, position).
4. Widget Registration:
   • Register the widget in app/Providers/Filament/AdminPanelProvider.php:

     public function panel(Panel $panel): Panel
     {
         return $panel
             ->widgets([
                 \MartinPetricko\FilamentSentryFeedback\Widgets\SentryFeedbackWidget::class,
             ]);
     }
     

5. Testing:
   • Deploy to staging and test the widget’s appearance and submission flow.
   • Use Sentry’s Issues API or Debugger to verify feedback is received.

Compatibility

• Filament Versions: Tested with Filament 3.x. Check the package’s release notes for version support.
• Sentry SDK: Relies on Sentry’s frontend SDK. Ensure no conflicts with existing Sentry initialization (e.g., Sentry.init() calls).
• Frontend Build Tools: If using custom Webpack/Vite setups, ensure the Sentry script is loaded after Filament’s assets. May require adjusting resources/js/app.js or vite.config.js.
• Multi-Tenancy: If using Filament in a multi-tenant context, ensure the Sentry DSN is dynamically set per tenant (e.g., via middleware or config overrides).

Sequencing

1. Phase 1: Setup (1-2 days)
   • Install and configure the package.
   • Register the widget in Filament.
   • Test basic functionality in staging.
2. Phase 2: Customization (0.5-1 day)
   • Adjust widget appearance (CSS/translations).
   • Configure Sentry project settings (e.g., issue categorization).
3. Phase 3: Integration (1-2 days)
   • Connect Sentry feedback to existing workflows (e.g., alerts, Jira).
   • Add local storage (if needed) via webhooks or Laravel models.
4. Phase 4: Rollout (0.5 day)
   • Deploy to production.
   • Monitor Sentry for feedback submissions.

Operational Impact

Maintenance

• Package Updates:
  • Monitor the package for updates (low frequency; last release in 2026 suggests active maintenance).
  • Update via Composer when Filament or Sentry SDK changes are announced.
• Configuration Drift:
  • Centralize Sentry DSN and widget settings in config files to avoid hardcoding.
  • Use environment variables for sensitive data (e.g., SENTRY_FEEDBACK_DSN).
• Dependency Management:
  • Watch for Filament major releases that might affect widget integration.

Support

• Troubleshooting:
  • Widget Not Appearing: Check Filament widget registration and frontend asset loading.
  • Feedback Not Submitted: Verify Sentry DSN, network requests (DevTools → Network tab), and Sentry project settings.
  • Styling Issues: Override CSS via Filament’s styles or tailwind.config.js.
• Support Channels:
  • Git