Weave Code
Flare Debug Sender Laravel Package
spatie/flare-debug-sender
Debug sender for Flare payloads, mainly for internal testing. Swap Flare’s sender to log, inspect, and optionally passthrough errors/traces/zipkin, replace tracing IDs/timestamps, and print parts or the full payload via configurable channels.
Flare debug sender to test payloads locally
Frequently asked questions about Flare Debug Sender
- How do I install spatie/flare-debug-sender in my Laravel project?
- Run `composer require spatie/flare-debug-sender` to install the package. Then publish Flare’s config with `php artisan vendor:publish --tag=flare-config` to customize the debug sender in `config/flare.php`.
- Does this package work with Laravel 10 and Flare v3?
- Yes, the package is explicitly built for Flare v3 (v2.0.0+) and supports Laravel 10. It aligns with Flare v3’s payload structure and requires PHP 8.1+, matching Flare’s official requirements.
- Can I use this to debug errors locally without sending them to Flare’s servers?
- Absolutely. Configure `passthrough_errors` and `passthrough_traces` to `false` in `flare.php` to block all payloads from being sent. Use channels like `LaravelLogDebugChannel` or `FileDebugChannel` to log payloads locally.
- What channels are available for debugging Flare payloads?
- The package includes `LaravelLogDebugChannel` (logs to Laravel’s log system), `FileDebugChannel` (saves to a file), and `RayDebugChannel` (requires Ray). You can also create custom channels by extending `DebugChannel`.
- How do I replace tracing IDs or timestamps in debug payloads?
- Set `replace_tracing_ids` and `replace_tracing_times` to `true` in the sender config. This modifies payloads locally before logging, ensuring consistency in testing environments without affecting production traces.
- Is it safe to disable SSL verification for local testing?
- SSL verification is disabled by default (`CURLOPT_SSL_VERIFYHOST` and `CURLOPT_SSL_VERIFYPEER` set to `0`) for convenience, but this introduces MITM risks. Only use this in trusted networks or override the config to enforce verification in production-like testing.
- Can I use this package in CI/CD pipelines to capture debug payloads?
- Yes, configure `FileDebugChannel` to write payloads to a CI-accessible path (e.g., `storage/logs/flare-debug.log`). Ensure the channel’s config includes the correct file permissions and path for your CI environment.
- What happens if I enable `print_full_payload` in production?
- Never enable `print_full_payload` in production. This exposes sensitive data like request payloads, error stacks, and environment variables. Keep it `false` and use it only in development or staging for debugging.
- How do I test custom error handlers or middleware with this package?
- Swap Flare’s sender to `FlareDebugSender` in `flare.php` and configure `passthrough_errors` to `true`. Trigger errors or edge cases locally, then inspect the logged payloads to validate your custom handlers or middleware behavior.
- Are there alternatives to spatie/flare-debug-sender for debugging Flare payloads?
- For Flare v3, this is the official debugging tool from Spatie. Alternatives like Laravel Telescope or Ray can log errors but lack Flare-specific payload inspection. For Flare v2, consider downgrading or using custom middleware to intercept payloads.
Weaver
How can I help you explore Laravel packages today?