Download the PHP package dennisbusk/debug-notary without Composer
On this page you can find all versions of the php package dennisbusk/debug-notary. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dennisbusk/debug-notary
More information about dennisbusk/debug-notary
Files in dennisbusk/debug-notary
Package debug-notary
Short Description A Laravel package for debug notarization.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package debug-notary
🐞 Debug Notary
Point-and-click bug reporting: See how users can annotate screenshots and submit bugs directly from your application.
Debug Notary is a powerful Laravel package designed to make debugging and user reporting effortless. It automatically captures system logs, tracks JavaScript errors, and provides a visual "Notary" button for users to report bugs with
screenshots, annotations, and browser data directly from your application.
❓ Why Debug Notary?
While tools like Laravel Pulse focus on Application Performance Monitoring (APM) (server health, slow queries, CPU usage), Debug Notary is a Bug Reporting & Error Tracking tool. It bridges the gap between the user's visual experience and the developer's technical requirements.
| Feature | Debug Notary | Laravel Pulse |
|---|---|---|
| User Interaction | ✅ Point-and-click reporting | ❌ No manual reports |
| Visual Context | ✅ Annotated Screenshots | ❌ No visuals |
| Frontend Monitoring | ✅ JS Errors & Console Logs | ❌ No |
| AI Integration | ✅ LLM-optimized exports | ❌ No |
| System Metrics | ❌ (CPU/RAM/SQL) | ✅ Yes |
🚀 Features
- Automatic Log Collection: Listens to Laravel's log events and stores them in your database.
- JavaScript Error Tracking: Automatically captures frontend errors (
window.onerror,window.onunhandledrejection) and console errors with full stack traces. - Smart De-duplication: Automatically groups similar errors by normalizing messages (redacting IDs, UUIDs, etc.) before hashing.
- Visual Notary Button: A discrete button injected into your application, allowing users to submit bug reports with screenshots (using marker.js), notes, and attachments.
- Intelligent Dashboard: A comprehensive Livewire-powered dashboard with dark mode support, trend statistics, status management (Open, In Progress, Resolved), and advanced filtering.
- GDPR Ready: Built-in "Pixelate" tool for screenshots to blur sensitive data, plus advanced data masking for context logs.
- Multi-Channel Notifications: Get alerted via Slack or Email when new unique errors occur, featuring built-in rate limiting and queue support.
- Screenshot & File Management: Support for storing screenshots and attachments as files on disk or as Base64 strings.
- User & Tenant Context: Automatically associates logs with authenticated users and their roles (compatible with Spatie Permissions).
- Markdown & LLM Export: Generate structured reports optimized for GitHub issues or AI analysis with a single click.
- Auto-Cleanup: Automatically prunes old logs using Laravel's
Prunabletrait, with configurable retention periods per log type. - Localization: Built-in support for English and Danish.
📖 Recipes & Best Practices
Log Cart Contents during Error
When an error occurs in your checkout flow, it's invaluable to see what was in the user's cart.
Attach Debug Logs manually
If you have a log file or a JSON export of the current state, users can attach it directly via the Notary button in the frontend.
Capture Auth State
Capture the current user's permissions to see if a bug is related to access rights.
📋 Requirements
- PHP: ^8.2
- Laravel: ^10.0, ^11.0, or ^12.0
- Livewire: ^3.0 or ^4.0
📦 Installation
Install the package via composer:
1. Run Migrations
The package requires a table to store recorded bugs:
2. Publish Configuration (Optional)
To customize the default settings, publish the configuration file:
3. Middleware
The package automatically injects the Notary button via a global middleware. If you've disabled automatic loading or need manual control, add the middleware to your web group:
4. Test Your Setup
Verify that notifications and basic logging are working correctly:
⚙️ Configuration
The configuration file config/debug-notary.php allows you to fine-tune the package:
enabled: Master toggle for the package.debug_level: Minimum log level to capture (default:error).system_log: Capture standard Laravel logs.notary_log: Enable/disable the manual reporting button.console_log: Automatically capture JS console errors.access_gate: Define a Gate to control who sees the button and dashboard.notifications: Configure Slack webhooks, Email recipients, and rate limiting.masking.fields: List of fields to redact from logs and context.
Access Control
To restrict access to the Debug Notary dashboard or button, define a gate in your AuthServiceProvider:
Then, update your config/debug-notary.php:
🛠 Usage
Manual Logging via Facade
Capture specific events manually in your PHP code:
Dashboard
Access the dashboard at /laravel-debug-notary.
The dashboard uses Tailwind CSS. If you are using a custom layout, ensure Tailwind is available. The default layout loads Tailwind via CDN for convenience.
Localization
To customize the text or add new languages, publish the language files:
🖥 Advanced Route Registration
By default, routes are registered automatically. To manually control route registration (e.g., to apply specific middleware), disable automatic registration in config/debug-notary.php:
Then, register them in your routes/web.php:
🔒 Security & GDPR
Debug Notary is built with data protection in mind. For a full overview, please see our SECURITY.md file.
- Pixelate/Blur Tool: Users can manually blur sensitive information on screenshots before submitting.
- Data Masking: Sensitive fields (passwords, tokens, etc.) are automatically redacted.
- Auto-Pruning: Configurable retention periods ensure you don't keep data longer than necessary.
📄 License
The MIT License (MIT). Please see License File for more information.
🤝 Contributing
Suggestions for improvements or bug reports? Open an issue or submit a pull request!
Created with ❤️ by Dennis Busk
All versions of debug-notary with dependencies
illuminate/support Version ^10.0|^11.0|^12.0
livewire/livewire Version ^3.0|^4.0