Download the PHP package apirelio/symfony without Composer

Apirelio Symfony SDK

See the customer behind every API request

Follow a release regression from the failing endpoint to the exact customer accounts it affects in the public, read-only workspace.

Explore the live demo →

Try it in 30 seconds

Copy the minimal setup below or run the quickstart example. Delivery is fail-safe and no request or response payloads are captured.

Documentation · Packagist · Apirelio

Connect Symfony API errors, latency and releases to the affected customers without capturing request or response payloads.

Fail-safe customer integration analytics for Symfony APIs. The bundle records normalized endpoint metrics and customer context without capturing request or response bodies, credentials, cookies, query strings, IP addresses, or personal data. The shared event contract, privacy rules and delivery primitives come from apirelio/php-core, installed automatically by Composer.

Requirements

• PHP 8.2+
• Symfony 6.4, 7.4 or 8.x

Symfony 8 itself requires PHP 8.4. Symfony 6.4 and 7.4 can be used on PHP 8.2.

Installation

Register the bundle:

Configure the project key shown once in the Apirelio dashboard:

The subscriber is registered automatically and records matching main requests. Route templates are used instead of concrete URLs, so /api/invoices/123 becomes /api/invoices/{invoice} and query strings are never sent.

Messenger transport

The default messenger transport moves network delivery outside the customer request. Route the SDK message to an asynchronous transport:

Run your normal Messenger worker:

Failed ingestion requests throw inside the worker so Symfony Messenger can apply its configured retry and failure transport policies.

Customer and application identity

Create application-specific resolvers:

Bind them to the SDK contracts:

Error codes and metadata

JSON error codes are read from error.code by default. Override a code or add allow-listed metadata during the current request:

Declare allowed custom keys in the bundle configuration:

Unlisted keys and non-scalar values are discarded.

Transports and buffering

• messenger (default): dispatch locally and deliver from an async worker.
• sync: deliver immediately; intended for local diagnostics.
• file_buffer: append to a locked local NDJSON buffer and flush by batch size or interval.

For file_buffer, schedule a forced flush so low-traffic applications do not leave a partial batch behind:

Useful options:

Resolver, transport, and logger failures are caught at the request boundary. Analytics may lose an event, but it never changes the customer API response or masks its exception.