Download the PHP package slogger/laravel without Composer

SLogger Laravel

SLogger Laravel is a tracing/observability package for Laravel apps. It records request/command/job/event/etc. traces and delivers them to a remote backend via configurable dispatchers.

This README documents installation, configuration, watchers, masking, dispatchers, profiling, and usage patterns.

Requirements

• PHP >= 8.2
• Laravel 10+ (tested), should work on Laravel 12
• Queue driver for queue dispatcher
• Optional: XHProf extension for profiling

Installation

1) Install the package (via Composer in your app):

2) Publish config:

3) Configure env and config/slogger.php (see below).

Quick Start

Enable and use the queue dispatcher:

Then start dispatcher workers:

Trace Collection Backend

SLogger Laravel sends traces to a separate backend service. The reference backend project is:

Use its setup instructions to provision the server and configure the API client URL/token in this package.

Custom backend / client

You can replace the backend by providing your own API client. Redefine ApiClientFactory::create and return a custom implementation of SLoggerLaravel\\Dispatcher\\ApiClients\\ApiClientInterface that sends traces to your backend.

Configuration

All configuration lives in config/slogger.php with environment overrides. Key sections:

General

• SLOGGER_ENABLED: globally toggle all tracing.
• SLOGGER_TOKEN: API token for dispatchers.
• SLOGGER_TRACE_ID_PREFIX: custom prefix for trace IDs. If empty, uses slugged app.name or app.
• SLOGGER_LOG_CHANNEL: where internal errors are logged.

Dispatchers

• SLOGGER_DISPATCHER: queue or memory.
• queue dispatcher runs worker processes (similar to Horizon) and sends traces via HTTP or socket client.
• memory dispatcher stores traces in memory (useful for tests/dev).

Profiling

Enables XHProf profiling for HTTP client traces (see Profiling section).

Request parent trace header

Allows linking child traces to parent requests via a custom header.

Watchers (enable/disable)

What SLogger Writes

Each trace contains:

• trace_id, parent_trace_id, type, status, tags
• data (watcher-specific payload)
• duration, memory, cpu, logged_at

Watcher data highlights:

• request: url, method, action, headers/params, response (for JSON responses)
• job: connection, payload, status, exception
• event: listeners, broadcast, optional serialized payload
• model: action, model class, key, changes
• mail: from/to/cc/bcc, subject, queued, mailable/notification
• notification: notifiable, channel, queued, response
• cache: type, key, tags, value
• db: query, bindings, time
• http-client: method, url, request/response
• schedule: command, description, cron, output
• dump, log, gate: dump/message/ability info

Requests

Middleware

For HTTP request tracing, add the middleware to the routes you want traced:

Request watcher config

config/slogger.php:

only_paths

• only_paths (top-level): log only matched request paths.
• input.only_paths: apply input masking only to matched paths (others are scrubbed).
• output.only_paths: apply output masking only to matched paths (others are scrubbed).

Patterns use Laravel Str::is matching.

JSON response size

Large JSON responses are skipped and marked with:

Masking Rules

Masking is pattern-based and configurable.

Masked values keep basic types:

• bool -> false
• int -> 0
• float -> 0.0
• string -> masked string
• arrays/objects -> masked string

Guzzle / HTTP Client tracing

You can attach the SLogger handler to Guzzle:

Dispatchers

Queue dispatcher

Start the dispatcher (spawns queue workers):

• Parent traces are sent immediately.
• Child traces are batched (default batch size: 5).
• Orphan traces are sent immediately.
• On shutdown, remaining traces are flushed.

Stop the dispatcher:

Memory dispatcher

Stores traces in memory only. Intended for tests/local development.

Storage

SLogger does not persist traces locally. The only local file is the dispatcher state file in:

You may want to ignore the folder:

Profiling (XHProf)

Only for HTTP client tracing.

1) Install extension:

2) Enable in php.ini:

3) Enable:

Testing

Run tests:

The testbench config uses in-memory sqlite and memory dispatcher.

Troubleshooting

• Dispatcher not starting: verify SLOGGER_ENABLED=true and correct dispatcher name.
• No traces: ensure watchers are enabled and middleware is applied for requests.
• Queue dispatcher not sending: check queue workers and API client URL.
• Socket client errors: verify socket address and backend availability.

License

MIT