diff --git a/CHANGELOG.md b/CHANGELOG.md index c990156..b2c6f24 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,29 @@ # CHANGELOG +## 1.0.0 + +The Sentry SDK team is happy to announce the immediate availability of Sentry PHP Agent v1.0.0. + +This is the first stable release of the Sentry PHP Agent, a local sidecar for PHP applications. The agent accepts +envelopes from the PHP SDK over the local interface and forwards them to Sentry asynchronously, reducing the network +latency paid by individual PHP requests. + +Use it alongside the PHP, Laravel, or Symfony SDKs: + +```bash +composer require sentry/sentry sentry/sentry-agent +vendor/bin/sentry-agent +``` + +```php +use Sentry\Agent\Transport\AgentClientBuilder; + +\Sentry\init([ + 'dsn' => '__YOUR_DSN__', + 'http_client' => AgentClientBuilder::create()->getClient(), +]); +``` + ## 0.1.1 - Internal release diff --git a/README.md b/README.md index f75cf37..eb2897e 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he # Official Sentry Agent for PHP -> [!CAUTION] -> The current state of this project is somewhere along the lines of pre-alpha. -> We strongly recommend you to not run this in production. -> During the `0.x` release cycle, we might introduce breaking changes at any time. - ## 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](https://github.com/getsentry/sentry-php) using [Composer](https://getcomposer.org/).