Docs · Getting started

Configuration

Unravel works with zero configuration. Everything below is optional, for when you want to tune what gets captured.

Publish the config file if you want to edit defaults:

php artisan vendor:publish --tag=unravel-config

Environment

Traces are labelled with your deployment environment so they stay grouped correctly in the dashboard (local, staging, production, …). This is read straight from your app's standard APP_ENV - there's nothing to configure.

Secret scrubbing

The SDK scrubs values under secret-looking keys (password, token, authorization, api_key, cookies, …) from captured data before it leaves your server. The deny-list is built in and not configurable in this release; a per-project scrub list is planned.

Scrubbing applies to runtime user data (request bodies, headers, cache values, payloads), never to developer-written identifiers like SQL text or class names. Positional SQL bindings have no key names to match on and are redacted server-side on arrival. See Security & privacy for the full model.

Noise control

Framework-internal queries and telemetry-about-telemetry are filtered at capture time so they never reach your timeline. You generally do not need to touch this.

Debugging delivery

If traces aren't showing up in the dashboard and you want to see what the SDK is doing, turn on transport logging:

UNRAVEL_DEBUG_TRANSPORT=true

Every flush is then logged with its status, latency, and event count, and any failures get the full error detail. Output goes to a dedicated storage/logs/unravel.log so it never clutters your laravel.log. Point it elsewhere with UNRAVEL_LOG_PATH if you prefer. Leave this off in production.

Disabling

To turn Unravel off without removing the package, unset the key or set:

UNRAVEL_ENABLED=false