sentry/sentry-agent

Sentry Agent for PHP (https://sentry.io)

1.0.0 2026-06-10 09:41 UTC

Requires

• php: ^7.2|^8
• ext-json: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.70

MIT

• Sentry

README

Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us Check out our open positions

Official Sentry Agent for PHP

Getting started

What is the Agent?

The Agent is a sidecar to the PHP application that is meant to run on the same machine in order to accept outgoing HTTP requests to Sentry and send them asynchronously without blocking the main PHP script.

Install

Install the agent alongside the PHP SDK using Composer.

composer require sentry/sentry sentry/sentry-agent

Configuration

Use the SDK-provided agent client as the custom HTTP client for the PHP (also Symfony & Laravel) SDKs.

use Sentry\Agent\Transport\AgentClientBuilder;

Sentry\init([
    'dsn' => '___PUBLIC_DSN___',
    'http_client' => AgentClientBuilder::create()->getClient(),
]);

Usage

vendor/bin/sentry-agent

Configuration

vendor/bin/sentry-agent [options]

• --listen=ADDRESS, defaults to 127.0.0.1:5148
• --upstream-timeout=SECONDS, defaults to 2.0 seconds
• --upstream-concurrency=REQUESTS, defaults to 10
• --queue-limit=ENVELOPES, the amount of envelopes to keep in memory, defaults to 1000
• --drain-timeout=SECONDS, defaults to 10.0 seconds
• --control-server=ADDRESS, enables the HTTP control server on the specified address
• --http-proxy=URL, forwards upstream envelope requests through an HTTP CONNECT proxy
• --http-proxy-authentication=AUTH, credentials for proxy basic authentication in username:password format

License

Licensed under the MIT license, see LICENSE