# Options | Sentry for PHP

Options are passed to the `init()` method as an array:

```php
\Sentry\init([
    'dsn' => '___PUBLIC_DSN___',
    'max_breadcrumbs' => 50,
]);
```

## [Available Options](https://docs.sentry.io/platforms/php/configuration/options.md#available-options)



## [Core Options](https://docs.sentry.io/platforms/php/configuration/options.md#core-options)

Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

### [dsn](https://docs.sentry.io/platforms/php/configuration/options.md#dsn)

| Type         | `string`     |
| ------------ | ------------ |
| ENV Variable | `SENTRY_DSN` |

The DSN tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the `SENTRY_DSN` environment variable. If that variable also does not exist, the SDK will just not send any events.

Learn more about [DSN utilization](https://docs.sentry.io/product/sentry-basics/dsn-explainer.md#dsn-utilization).

### [logger](https://docs.sentry.io/platforms/php/configuration/options.md#logger)

| Type    | `\Psr\Log\LoggerInterface` |
| ------- | -------------------------- |
| Default | `null`                     |

If enabled, the SDK prints out debug information about if something went wrong while sending events. It isn't recommended to use this in production.

```php
// This logs messages to the provided file path
Sentry\init([
    'logger' => new \Sentry\Logger\DebugFileLogger(filePath: ROOT . DS . 'sentry.log'),
]);

// This logs messages to stdout
Sentry\init([
    'logger' => new \Sentry\Logger\DebugStdOutLogger(),
]);
```

### [release](https://docs.sentry.io/platforms/php/configuration/options.md#release)

| Type         | `string`         |
| ------------ | ---------------- |
| ENV Variable | `SENTRY_RELEASE` |

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](https://docs.sentry.io/product/releases.md) or the [sandbox](https://sandbox.sentry.io/?scenario=releases\&source=docs).

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

### [environment](https://docs.sentry.io/platforms/php/configuration/options.md#environment)

| Type         | `string`             |
| ------------ | -------------------- |
| Default      | `production`         |
| ENV Variable | `SENTRY_ENVIRONMENT` |

Sets the environment. This string is freeform and set to `production` by default. A release can be associated with more than one environment to separate them in the UI (think `staging` vs `production` or similar).

```php
\Sentry\init([
    'environment' => 'production',
]);
```

By default, the SDK will try to read this value from the `SENTRY_ENVIRONMENT` environment variable.

### [max\_breadcrumbs](https://docs.sentry.io/platforms/php/configuration/options.md#max_breadcrumbs)

| Type    | `int` |
| ------- | ----- |
| Default | `100` |

This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped.

### [attach\_stacktrace](https://docs.sentry.io/platforms/php/configuration/options.md#attach_stacktrace)

| Type    | `bool`  |
| ------- | ------- |
| Default | `false` |

When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.

Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events.

### [send\_default\_pii](https://docs.sentry.io/platforms/php/configuration/options.md#send_default_pii)

| Type    | `bool`  |
| ------- | ------- |
| Default | `false` |

If this flag is enabled, certain personally identifiable information (PII) is added by active integrations.

This option is turned off by default.

If you enable this option, be sure to manually remove what you don't want to send using our features for managing [*Sensitive Data*](https://docs.sentry.io/platforms/php/data-management/sensitive-data.md).

### [server\_name](https://docs.sentry.io/platforms/php/configuration/options.md#server_name)

| Type    | `string`        |
| ------- | --------------- |
| Default | `gethostname()` |

This option can be used to supply a server name. When provided, the name of the server is sent along and persisted in the event. For many integrations, the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server.

### [in\_app\_include](https://docs.sentry.io/platforms/php/configuration/options.md#in_app_include)

| Type    | `string[]` |
| ------- | ---------- |
| Default | `[]`       |

A list of string prefixes of module names that belong to the app. This option takes precedence over `in_app_exclude`.

Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as `inApp`. The difference is visible in [sentry.io](https://sentry.io), where only the "in application" frames are displayed by default.

### [in\_app\_exclude](https://docs.sentry.io/platforms/php/configuration/options.md#in_app_exclude)

| Type    | `string[]` |
| ------- | ---------- |
| Default | `[]`       |

A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.

This option can be overridden using `in_app_include`.

### [prefixes](https://docs.sentry.io/platforms/php/configuration/options.md#prefixes)

| Type    | `string[]` |
| ------- | ---------- |
| Default | `[]`       |

A list of prefixes that should be stripped from the filenames of captured stacktraces to make them relative. This helps in normalizing file paths across different environments.

For example, if your code is deployed in different locations across environments (e.g., `/var/www/app` in production and `/home/user/projects/app` in development), you can use this option to strip these prefixes and make the paths consistent.

```php
\Sentry\init([
    'dsn' => '___DSN___',
    'prefixes' => [
        '/var/www/',
        '/home/user/projects/',
    ],
]);
```

### [max\_request\_body\_size](https://docs.sentry.io/platforms/php/configuration/options.md#max_request_body_size)

| Type    | `string` |
| ------- | -------- |
| Default | `medium` |

This parameter controls whether integrations should capture HTTP request bodies. It can be set to one of the following values:

* `never`: Request bodies are never sent.
* `small`: Only small request bodies will be captured. The cutoff for small depends on the SDK (typically 4KB).
* `medium`: Medium and small requests will be captured (typically 10KB).
* `always`: The SDK will always capture the request body as long as Sentry can make sense of it.

### [max\_value\_length](https://docs.sentry.io/platforms/php/configuration/options.md#max_value_length)

| Type    | `int`  |
| ------- | ------ |
| Default | `1024` |

The number of characters after which the values containing text in the event payload will be truncated.

If the value you set for this is exceptionally large, the event may exceed 1 MiB and will be dropped by Sentry.

### [before\_breadcrumb](https://docs.sentry.io/platforms/php/configuration/options.md#before_breadcrumb)

| Type | `function (\Sentry\Breadcrumb $breadcrumb): \Sentry\Breadcrumb` |
| ---- | --------------------------------------------------------------- |

This function is called with a breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the breadcrumb itself.

## [Error Monitoring Options](https://docs.sentry.io/platforms/php/configuration/options.md#error-monitoring-options)

### [sample\_rate](https://docs.sentry.io/platforms/php/configuration/options.md#sample_rate)

| Type    | `float` |
| ------- | ------- |
| Default | `1.0`   |

Configures the sample rate for error events, in the range of `0.0` to `1.0`. The default is `1.0`, which means that 100% of error events will be sent. If set to `0.1`, only 10% of error events will be sent. Events are picked randomly.

### [before\_send](https://docs.sentry.io/platforms/php/configuration/options.md#before_send)

| Type | `function (\Sentry\Event $event, ?\Sentry\EventHint $hint): ?\Sentry\Event` |
| ---- | --------------------------------------------------------------------------- |

This function is called with an event object, and can return a modified event object, or `null` to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.

By the time `before_send` is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.

### [ignore\_exceptions](https://docs.sentry.io/platforms/php/configuration/options.md#ignore_exceptions)

| Type | `string[]` |
| ---- | ---------- |

A list of class names that matches exceptions that shouldn't be sent to Sentry. Checks whether the provided class name is of a given type or subtype.

### [error\_types](https://docs.sentry.io/platforms/php/configuration/options.md#error_types)

| Type    | `int`               |
| ------- | ------------------- |
| Default | `error_reporting()` |

Sets which errors are reported. It takes the same values as PHP's [`error_reporting`](https://www.php.net/manual/errorfunc.configuration.php#ini.error-reporting) configuration parameter.

By default, the error types reported are determined by the value returned by the `error_reporting()` function.

### [context\_lines](https://docs.sentry.io/platforms/php/configuration/options.md#context_lines)

| Type    | `int` |
| ------- | ----- |
| Default | `5`   |

The number of context lines for each frame in the stack trace when loading a file.

## [Tracing Options](https://docs.sentry.io/platforms/php/configuration/options.md#tracing-options)

### [traces\_sample\_rate](https://docs.sentry.io/platforms/php/configuration/options.md#traces_sample_rate)

| Type    | `float` |
| ------- | ------- |
| Default | `null`  |

A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app.

Either this or `traces_sampler` must be defined to enable tracing.

### [traces\_sampler](https://docs.sentry.io/platforms/php/configuration/options.md#traces_sampler)

| Type    | `function (\Sentry\Tracing\SamplingContext $context): float` |
| ------- | ------------------------------------------------------------ |
| Default | `null`                                                       |

A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between `0` (0% chance of being sent) and `1` (100% chance of being sent). Can also be used for filtering transactions, by returning `0` for those that are unwanted.

Either this or `traces_sample_rate` must be defined to enable tracing.

### [ignore\_transactions](https://docs.sentry.io/platforms/php/configuration/options.md#ignore_transactions)

| Type | `string[]` |
| ---- | ---------- |

A list of strings that match transaction names that shouldn't be sent to Sentry.

### [before\_send\_transaction](https://docs.sentry.io/platforms/php/configuration/options.md#before_send_transaction)

| Type | `function (\Sentry\Event $transaction, ?\Sentry\EventHint $hint): ?\Sentry\Event` |
| ---- | --------------------------------------------------------------------------------- |

This function is called with a transaction event object, and can return a modified transaction event object, or `null` to skip reporting the event. One way this might be used is for manual PII stripping before sending.

### [trace\_propagation\_targets](https://docs.sentry.io/platforms/php/configuration/options.md#trace_propagation_targets)

| Type    | `string[]` |
| ------- | ---------- |
| Default | `null`     |

An optional property that controls which downstream services receive tracing data, in the form of a `sentry-trace` and a `baggage` header attached to any outgoing HTTP requests.

The option may contain a list of strings against which the hosts of outgoing requests are matched. If one of the entries in the list matches the host of an outgoing request, trace data will be attached to that request.

If `trace_propagation_targets` is not provided (or set to `null`), trace data is attached to every outgoing request from the [instrumented client](https://docs.sentry.io/platforms/php/tracing/instrumentation/requests-module.md). To disable sending trace data to any downstream service, set this option to an empty array (`[]`).

## [Cron Monitoring Options](https://docs.sentry.io/platforms/php/configuration/options.md#cron-monitoring-options)

### [before\_send\_check\_in](https://docs.sentry.io/platforms/php/configuration/options.md#before_send_check_in)

| Type | `function (\Sentry\Event $checkIn, ?\Sentry\EventHint $hint): ?\Sentry\Event` |
| ---- | ----------------------------------------------------------------------------- |

This function is called with a check-in event object, and can return a modified check-in event object, or `null` to skip reporting the event.

## [Logs Options](https://docs.sentry.io/platforms/php/configuration/options.md#logs-options)

### [enable\_logs](https://docs.sentry.io/platforms/php/configuration/options.md#enable_logs)

| Type    | `bool`  |
| ------- | ------- |
| Default | `false` |

This option enables the logging integration, which allows the SDK to capture logs and send them to Sentry. This is disabled by default.

### [before\_send\_log](https://docs.sentry.io/platforms/php/configuration/options.md#before_send_log)

| Type | `function (\Sentry\Logs\Log $log): ?\Sentry\Logs\Log` |
| ---- | ----------------------------------------------------- |

This function is called with a log object, and can return a modified log event object, or `null` to skip reporting the event.

## [Metrics Options](https://docs.sentry.io/platforms/php/configuration/options.md#metrics-options)

### [enable\_metrics](https://docs.sentry.io/platforms/php/configuration/options.md#enable_metrics)

| Type    | `bool` |
| ------- | ------ |
| Default | `true` |

This option enables the metrics feature, which allows the SDK to send metrics. This is enabled by default.

### [before\_send\_metric](https://docs.sentry.io/platforms/php/configuration/options.md#before_send_metric)

| Type | `function (\Sentry\Metrics\Types\Metric $metric): ?\Sentry\Metrics\Types\Metric` |
| ---- | -------------------------------------------------------------------------------- |

This function is called with a metric object, and can return a modified metric object, or `null` to skip the metric.

## [Transport Options](https://docs.sentry.io/platforms/php/configuration/options.md#transport-options)

Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.

### [transport](https://docs.sentry.io/platforms/php/configuration/options.md#transport)

| Type    | `\Sentry\Transport\TransportInterface` |
| ------- | -------------------------------------- |
| Default | `null`                                 |

Switches out the transport used to send events. It can, for instance, be used to capture events for unit testing.

### [http\_client](https://docs.sentry.io/platforms/php/configuration/options.md#http_client)

| Type    | `\Sentry\HttpClient\HttpClientInterface` |
| ------- | ---------------------------------------- |
| Default | `null`                                   |

Switches out the HTTP client used by the SDKs transport.

### [http\_proxy](https://docs.sentry.io/platforms/php/configuration/options.md#http_proxy)

| Type    | `string` |
| ------- | -------- |
| Default | `null`   |

When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests.

### [http\_proxy\_authentication](https://docs.sentry.io/platforms/php/configuration/options.md#http_proxy_authentication)

| Type    | `string` |
| ------- | -------- |
| Default | `null`   |

Sets proxy authentication when using `http_proxy`.

### [http\_connect\_timeout](https://docs.sentry.io/platforms/php/configuration/options.md#http_connect_timeout)

| Type    | `int` |
| ------- | ----- |
| Default | `2`   |

The maximum number of seconds to wait while trying to connect to a server.

### [http\_timeout](https://docs.sentry.io/platforms/php/configuration/options.md#http_timeout)

| Type    | `int` |
| ------- | ----- |
| Default | `5`   |

The maximum execution time, in seconds, for the request+response as a whole. The value should also include the time for the connect phase, so it should be greater than the value set for the `http_connect_timeout` option.

### [http\_ssl\_verify\_peer](https://docs.sentry.io/platforms/php/configuration/options.md#http_ssl_verify_peer)

| Type    | `bool` |
| ------- | ------ |
| Default | `true` |

Controls SSL peer verification for outbound requests.

### [http\_ssl\_native\_ca](https://docs.sentry.io/platforms/php/configuration/options.md#http_ssl_native_ca)

| Type    | `bool`  |
| ------- | ------- |
| Default | `false` |

When enabled, the SDK will use the native OS certificate store.

### [http\_compression](https://docs.sentry.io/platforms/php/configuration/options.md#http_compression)

| Type    | `bool` |
| ------- | ------ |
| Default | `true` |

When enabled, request payloads are gzipped if the `zlib` extension is available.

## [Profile Options](https://docs.sentry.io/platforms/php/configuration/options.md#profile-options)

### [profiles\_sample\_rate](https://docs.sentry.io/platforms/php/configuration/options.md#profiles_sample_rate)

| Type    | `float` |
| ------- | ------- |
| Default | `null`  |

A number between `0` and `1`, controlling the percentage chance a given profile will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Setting this to a non null value will enable profiling.
