# CHANGELOG

## 5.12.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.12.0.

### Bug fixes

- Start the runtime context before the router and security firewall to prevent logs and breadcrumbs from leaking across requests on persistent workers. [(#1043)](https://github.com/getsentry/sentry-symfony/pull/1043)

### Misc

- Add support for `guzzlehttp/psr7` 3.x for Guzzle 8 compatibility. [(#1046)](https://github.com/getsentry/sentry-symfony/pull/1046)

## 5.11.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.11.0.

### Bug fixes

- Escape values rendered by the Twig `sentry_trace_meta()` and `sentry_baggage_meta()` helpers. [(#1025)](https://github.com/getsentry/sentry-symfony/pull/1025)
- Clear the active request from `RequestFetcher` during kernel termination even when no transaction is set on the hub. [(#1026)](https://github.com/getsentry/sentry-symfony/pull/1026)
- Use Symfony's `security.untracked_token_storage` service in `LoginListener`. [(#1028)](https://github.com/getsentry/sentry-symfony/pull/1028)

## 5.10.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.10.0.

### Features

- Add support for `strict_trace_continuation` and `org_id` to continue incoming traces only when they belong to the same Sentry organization. [(#1002)](https://github.com/getsentry/sentry-symfony/pull/1002)
- Add `ConsoleInputSerializer` to capture console command arguments and options via `class_serializers`. [(#1007)](https://github.com/getsentry/sentry-symfony/pull/1007)
- Add support for `log_flush_threshold` to flush logs once a configured batch size is reached. [(#1012)](https://github.com/getsentry/sentry-symfony/pull/1012)
- Add support for `Sentry\Integration\OTLPIntegration`. [(#1014)](https://github.com/getsentry/sentry-symfony/pull/1014)
- Add `tracing.dbal.ignore_prepare_spans` to suppress `db.sql.prepare` spans for prepared queries. [(#1016)](https://github.com/getsentry/sentry-symfony/pull/1016)
- Isolate runtime context between HTTP requests on persistent workers, and add `messenger.isolate_context_by_message` to prevent scope, logs, and metrics data from leaking across messages. [(#997)](https://github.com/getsentry/sentry-symfony/pull/997)

### Bug fixes

- Remove the deprecated `traceparent` header. [(#1005)](https://github.com/getsentry/sentry-symfony/pull/1005)

### Misc

- Bump `sentry-php` version to `4.23.0`. [(#1012)](https://github.com/getsentry/sentry-symfony/pull/1012)

## 5.9.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.9.0.

### Misc

- Bump `sentry-php` version to `4.20.0`. [(#996)](https://github.com/getsentry/sentry-symfony/pull/996)

## 5.8.3

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.8.3.

### Bug fixes

- Using caches with namespaces will no longer cause an error. [(#986)](https://github.com/getsentry/sentry-symfony/pull/986)

## 5.8.2

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.8.2.

### Bug fixes

- Move `symfony/yaml` to a non-dev dependency. [(#983)](https://github.com/getsentry/sentry-symfony/pull/983)

## 5.8.1

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.8.1.

### Improvements

- Add support for `before_send_metric` and `enable_metrics`. [(#981)](https://github.com/getsentry/sentry-symfony/pull/981)

## 5.8.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.8.0.

### Features

- Add support for Sentry metrics. ([#977])(https://github.com/getsentry/sentry-symfony/pull/977)
```php
// Counter metric
\Sentry\trace_metrics()->count('test-counter', 10, ['my-attribute' => 'foo']);

// Gauge metric
\Sentry\trace_metrics()->gauge('test-gauge', 50.0, ['my-attribute' => 'foo'], \Sentry\Unit::millisecond());

// Distribution metric
\Sentry\trace_metrics()->distribution('test-distribution', 20.0, ['my-attribute' => 'foo'], \Sentry\Unit::kilobyte());
```

## 5.7.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.7.0.

### Features

- Add support for Symfony 8. [(#968)](https://github.com/getsentry/sentry-symfony/pull/968)

### Misc

- Add `never` as valid option for `max_request_body_size`. [(#966)](https://github.com/getsentry/sentry-symfony/pull/966)

## 5.6.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.6.0.

### Features

- Remove upper limit for `max_breadcrumbs` option. [(#953)](https://github.com/getsentry/sentry-symfony/pull/953)
- Allow passing string and enum Monolog level. [(#959)](https://github.com/getsentry/sentry-symfony/pull/959)
```yaml
services:
  Sentry\SentryBundle\Monolog\LogsHandler:
    arguments:
      - 'info'
```

```yaml
# or using PSR constants
services:
  Sentry\SentryBundle\Monolog\LogsHandler:
    arguments:
      - !php/const Psr\Log\LogLevel::INFO
```

```php
// or via PHP config
$container->services()
    ->set(\Sentry\SentryBundle\Monolog\LogsHandler::class)
    ->args([\Monolog\Level::Info]);
```

## 5.5.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.5.0.

### Features

- Enable auto-instrumentation for the Symfony Cache Component [(#942)](https://github.com/getsentry/sentry-symfony/pull/942)
- Add a new config flag to reset breadcrumbs between Symfony messages [(#946)](https://github.com/getsentry/sentry-symfony/pull/946)
```yaml
sentry:
  messenger:
    isolate_breadcrumbs_by_message: true
```
- Allow to pass in callbacks to configure SDK integrations [(#947)](https://github.com/getsentry/sentry-symfony/pull/947)
```yaml
services:
    App\IntegrationCallback:
        factory: ['App\IntegrationCallback', 'factory']

sentry:
    options:
        integrations: 'App\IntegrationCallback'
```

## 5.4.1

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.4.1.

### Bug Fixes

- Support named arguments in BufferFlushPass. [(#948)](https://github.com/getsentry/sentry-symfony/pull/948)

## 5.4.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.4.0.

### Features

- Introduce Sentry Structured Logging support. [(#940)](https://github.com/getsentry/sentry-symfony/pull/940)

```yaml
sentry:
  options:
    enable_logs: true

services:
  Sentry\SentryBundle\Monolog\LogsHandler:
    arguments:
      - !php/const Monolog\Logger::INFO

monolog:
  handlers:
    sentry_logs:
      type: service
      id: Sentry\SentryBundle\Monolog\LogsHandler
```

### Bug Fixes

- Add buffer flusher for sentry monolog handler. [(#936)](https://github.com/getsentry/sentry-symfony/pull/936)

## 5.3.1

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.3.1.

### Bug Fixes

- Fix exception thrown when invalid IP address was captured by the request listener [(#931)](https://github.com/getsentry/sentry-symfony/pull/931)

## 5.3.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.3.0.

### Features

- Implement `NamespacedPoolInterface` for `TraceableCacheAdapterForV3` [(#927)](https://github.com/getsentry/sentry-symfony/pull/927)

### Misc

- Update minimum required version of `sentry/sentry` to `^4.14.1`
- Remove support for `traceparent` header [(#928)](https://github.com/getsentry/sentry-symfony/pull/928)

## 5.2.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.2.0.

### Features

- Allow to configure the logger via the `sentry.yaml` configuration file [(#899)](https://github.com/getsentry/sentry-symfony/pull/899)

  ```yaml
  sentry:
    dsn: "%env(SENTRY_DSN)%"
    options:
        logger: "sentry.logger"

  services:
    sentry.logger:
      class: 'Sentry\Logger\DebugFileLogger'
      arguments:
          $filePath: '../../var/log/sentry.log'
  ```

### Bug Fixes

- Fixed updating the user context when a route is marked as stateless [(#910)](https://github.com/getsentry/sentry-symfony/pull/910)

### Misc

- Remove `symfony/security-core` and `symfony/security-http` as dependencies [(#912)](https://github.com/getsentry/sentry-symfony/pull/912)

## 5.1.0

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.1.0.

### Features

- The SDK was updated to support PHP 8.4 [(#893)](https://github.com/getsentry/sentry-symfony/pull/893)
- Set the status for CLI command transactions based on the exit code [(#891)](https://github.com/getsentry/sentry-symfony/pull/891)

### Bug Fixes

- Fix including request data on transactions  [(#879)](https://github.com/getsentry/sentry-symfony/pull/879)

## 5.0.1

The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.0.1.

### Bug Fixes

- Add missing `setCallbackWrapper` method to `TraceableCacheAdapterTrait` [(#841)](https://github.com/getsentry/sentry-symfony/pull/841)
- Fix detection of the `symfony/http-client` being installed [(#858)](https://github.com/getsentry/sentry-symfony/pull/858)

## 5.0.0

The Sentry SDK team is thrilled to announce the immediate availability of Sentry Symfony SDK v5.0.0.

### Breaking Change

Please refer to the [UPGRADE-5.0.md](https://github.com/getsentry/sentry-symfony/blob/master/UPGRADE-5.0.md) guide for a complete list of breaking changes.

This version adds support for the underlying [Sentry PHP SDK v4.0](https://github.com/getsentry/sentry-php).
Please refer to the PHP SDK [sentry-php/UPGRADE-4.0.md](https://github.com/getsentry/sentry-php/blob/master/UPGRADE-4.0.md) guide for a complete list of breaking changes.

- This version exclusively uses the [envelope endpoint](https://develop.sentry.dev/sdk/envelopes/) to send event data to Sentry.

  If you are using [sentry.io](https://sentry.io), no action is needed.
  If you are using an on-premise/self-hosted installation of Sentry, the minimum requirement is now version `>= v20.6.0`.

- You need to have `ext-curl` installed to use the SDK.

- The `IgnoreErrorsIntegration` integration was removed. Use the `ignore_exceptions` option instead.
  Previously, both `Symfony\Component\ErrorHandler\Error\FatalError` and `Symfony\Component\Debug\Exception\FatalErrorException` were ignored by default.
  To continue ignoring these exceptions, make the following changes to the config file:

  ```yaml
  // config/packages/sentry.yaml

  sentry:
    options:
      ignore_exceptions:
        - 'Symfony\Component\ErrorHandler\Error\FatalError'
        - 'Symfony\Component\Debug\Exception\FatalErrorException'
  ```

  This option performs an [`is_a`](https://www.php.net/manual/en/function.is-a.php) check now, so you can also ignore more generic exceptions.

### Features

- Add support for Sentry Developer Metrics [(#1619)](https://github.com/getsentry/sentry-php/pull/1619)

  ```php
  use function Sentry\metrics;

  // Add 4 to a counter named hits
  metrics()->increment(key: 'hits', value: 4);

  // Add 25 to a distribution named response_time with unit milliseconds
  metrics()->distribution(key: 'response_time', value: 25, unit: MetricsUnit::millisecond());

  // Add 2 to gauge named parallel_requests, tagged with type: "a"
  metrics()->gauge(key: 'parallel_requests', value: 2, tags: ['type': 'a']);

  // Add a user's email to a set named users.sessions, tagged with role: "admin"
  metrics()->set('users.sessions', 'jane.doe@example.com', null, ['role' => User::admin()]);
  ```

  Metrics are automatically sent to Sentry at the end of a request, hooking into Symfony's `kernel.terminate` event.

- Add new fluent APIs [(#1601)](https://github.com/getsentry/sentry-php/pull/1601)

  ```php
  // Before
  $transactionContext = new TransactionContext();
  $transactionContext->setName('GET /example');
  $transactionContext->setOp('http.server');

  // After
  $transactionContext = (new TransactionContext())
      ->setName('GET /example');
      ->setOp('http.server');
  ```

- Simplify the breadcrumb API [(#1603)](https://github.com/getsentry/sentry-php/pull/1603)

  ```php
  // Before
  \Sentry\addBreadcrumb(
      new \Sentry\Breadcrumb(
          \Sentry\Breadcrumb::LEVEL_INFO,
          \Sentry\Breadcrumb::TYPE_DEFAULT,
          'auth',                // category
          'User authenticated',  // message (optional)
          ['user_id' => $userId] // data (optional)
      )
  );

  // After
  \Sentry\addBreadcrumb(
      category: 'auth',
      message: 'User authenticated', // optional
      metadata: ['user_id' => $userId], // optional
      level: Breadcrumb::LEVEL_INFO, // set by default
      type: Breadcrumb::TYPE_DEFAULT, // set by default
  );
  ```

- New default cURL HTTP client [(#1589)](https://github.com/getsentry/sentry-php/pull/1589)

  The SDK now ships with its own HTTP client based on cURL. A few new options were added.

  ```yaml
  // config/packages/sentry.yaml

  sentry:
    options:
      - http_proxy_authentication: 'username:password' // user name and password to use for proxy authentication
      - http_ssl_verify_peer: false // default true, verify the peer's SSL certificate
      - http_compression: false // default true, http request body compression
  ```

  To use a different client, you may use the `http_client` option.
  To use a different transport, you may use the `transport` option. A custom transport must implement the `TransportInterface`.
  If you use the `transport` option, the `http_client` option has no effect.

### Misc

- The abandoned package `php-http/message-factory` was removed.