Skip to content

php-sdk: standardize options type declarations #15807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shemanaev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

php-sdk: standardize options type declarations #15807

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/platforms/php/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-uti

</SdkOption>

<SdkOption name="logger" type='LoggerInterface' defaultValue='null'>
<SdkOption name="logger" type='\Psr\Log\LoggerInterface' defaultValue='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.
Expand Down Expand Up @@ -111,7 +111,7 @@ For example, if your code is deployed in different locations across environments

</SdkOption>

<SdkOption name="max_request_body_size"type='string' defaultValue='medium'>
<SdkOption name="max_request_body_size" type='string' defaultValue='medium'>

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

Expand All @@ -133,7 +133,7 @@ The number of characters after which the values containing text in the event pay

</SdkOption>

<SdkOption name="before_breadcrumb" type='function (Breadcrumb $breadcrumb): Breadcrumb'>
<SdkOption name="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.

Expand All @@ -147,7 +147,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The

</SdkOption>

<SdkOption name="before_send" type='function (Event $event): Event'>
<SdkOption name="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.

Expand Down Expand Up @@ -187,7 +187,7 @@ Either this or `traces_sampler` must be defined to enable tracing.

</SdkOption>

<SdkOption name="traces_sampler" type='function' defaultValue='null'>
<SdkOption name="traces_sampler" type='function (\Sentry\Tracing\SamplingContext $context): float' defaultValue='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.

Expand All @@ -201,7 +201,7 @@ A list of strings that match transaction names that shouldn't be sent to Sentry.

</SdkOption>

<SdkOption name="before_send_transaction" type='function (Event $transaction): Event'>
<SdkOption name="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.

Expand All @@ -221,7 +221,7 @@ To disable sending trace data to any downstream service, set this option to an e

## Cron Monitoring Options

<SdkOption name="before_send_check_in" type='function (Event $checkIn): Event'>
<SdkOption name="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.

Expand Down Expand Up @@ -259,13 +259,13 @@ This function is called with a metric object, and can return a modified metric o

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

<SdkOption name="transport" type="TransportInterface" defaultValue='null'>
<SdkOption name="transport" type="\Sentry\Transport\TransportInterface" defaultValue='null'>

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

</SdkOption>

<SdkOption name="http_client" type="HttpClientInterface" defaultValue="null">
<SdkOption name="http_client" type="\Sentry\HttpClient\HttpClientInterface" defaultValue="null">

Switches out the HTTP client used by the SDKs transport.

Expand Down