spatie/flare-debug-sender

Debugging tool for Flare payloads

1.0.3 2025-05-23 13:51 UTC

This package is auto-updated.

Last update: 2025-05-23 14:00:49 UTC


README

Latest Version on Packagist Tests Total Downloads

This is a debug sender for Flare payloads, mostly used for internal testing purposes.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/flare-debug-sender

Usage

Within your Flare config:

    'sender' => [
        'class' => \Spatie\FlareDebugSender\FlareDebugSender::class,
        'config' => ['passthrough_errors' => false,
            'passthrough_traces' => false,
            'passthrough_zipkin' => false,
            'replace_tracing_ids' => true,
            'replace_tracing_times' => true,
            'print_full_payload' => false,
        ],
    ],

Open up Ray and start debugging!

Options

  • passthrough_errors: If set to true, errors will be passed through to the default sender.
  • passthrough_traces: If set to true, traces will be passed through to the default sender.
  • passthrough_zipkin: If set to true, traces will be sent to a local Zipkin instance.
  • replace_tracing_ids: If set to true, the span ids will be replaced with a more readable version.
  • replace_tracing_times: If set to true, the start and end times of the spans will be replaced with a more readable version.
  • print_full_payload: If set to true, the full payload will be printed to ray.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.