From e4a02c3e64f0cb665c9dbacb059b20f4b090a1f8 Mon Sep 17 00:00:00 2001 From: Alexander Alderman Webb Date: Tue, 30 Sep 2025 14:35:25 +0200 Subject: [PATCH] docs: Remove generic references from PHP --- .../platforms/php/common/configuration/filtering.mdx | 4 ++-- docs/platforms/php/common/configuration/options.mdx | 12 ++++++------ docs/platforms/php/common/configuration/sampling.mdx | 2 +- .../common/data-management/sensitive-data/index.mdx | 8 +++----- .../common/enriching-events/breadcrumbs/index.mdx | 4 ++-- .../php/common/enriching-events/context/index.mdx | 2 +- .../common/enriching-events/identify-user/index.mdx | 2 +- .../php/common/usage/sdk-fingerprinting/index.mdx | 2 +- .../laravel/enriching-events/identify-user/index.mdx | 2 +- 9 files changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/platforms/php/common/configuration/filtering.mdx b/docs/platforms/php/common/configuration/filtering.mdx index 28659183bbad0d..b087b34dbe4795 100644 --- a/docs/platforms/php/common/configuration/filtering.mdx +++ b/docs/platforms/php/common/configuration/filtering.mdx @@ -30,7 +30,7 @@ Typically, a `hint` holds the original exception so that additional data can be -When the SDK creates an event or breadcrumb for transmission, that transmission is typically created from some sort of source object. For instance, an error event is typically created from a log record or exception instance. For better customization, SDKs send these objects to certain callbacks (, or the event processor system in the SDK). +When the SDK creates an event or breadcrumb for transmission, that transmission is typically created from some sort of source object. For instance, an error event is typically created from a log record or exception instance. For better customization, the SDK sends these objects to certain callbacks (, and event processors). ### Using Hints @@ -43,7 +43,7 @@ Event and breadcrumb `hints` are objects containing various information used to For events, hints contain properties such as `event_id`, `originalException`, `syntheticException` (used internally to generate cleaner stack trace), and any other arbitrary `data` that you attach. -For breadcrumbs, the use of `hints` is implementation dependent. For XHR requests, the hint contains the xhr object itself; for user interactions the hint contains the DOM element and event name and so forth. +For breadcrumbs, the use of `hints` depends on the type of breadcrumb. diff --git a/docs/platforms/php/common/configuration/options.mdx b/docs/platforms/php/common/configuration/options.mdx index 4faa012eefc978..cef15fac090bc9 100644 --- a/docs/platforms/php/common/configuration/options.mdx +++ b/docs/platforms/php/common/configuration/options.mdx @@ -135,7 +135,7 @@ The number of characters after which the values containing text in the event pay -This function is called with an SDK-specific 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 first argument, which contains the breadcrumb object. +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 first argument, which contains the breadcrumb object. The callback typically gets a second argument (called a "hint") which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like. @@ -151,7 +151,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This function is called with an SDK-specific message or error 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. +This function is called with the event payload, 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. @@ -205,7 +205,7 @@ A list of strings that match transaction names that shouldn't be sent to Sentry. -This function is called with an SDK-specific 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. +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. @@ -225,7 +225,7 @@ To disable sending trace data to any downstream service, set this option to an e -This function is called with an SDK-specific check-in event object, and can return a modified check-in event object, or `null` to skip reporting the 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. @@ -239,7 +239,7 @@ This option enables the logging integration, which allows the SDK to capture log -This function is called with an SDK-specific log object, and can return a modified log event object, or `null` to skip reporting the event. +This function is called with a log object, and can return a modified log event object, or `null` to skip reporting the event. @@ -249,7 +249,7 @@ Transports are used to send events to Sentry. Transports can be customized to so -Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication. +Switches out the transport used to send events. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication. diff --git a/docs/platforms/php/common/configuration/sampling.mdx b/docs/platforms/php/common/configuration/sampling.mdx index 95970896348e84..02f3fccf4cea0c 100644 --- a/docs/platforms/php/common/configuration/sampling.mdx +++ b/docs/platforms/php/common/configuration/sampling.mdx @@ -58,7 +58,7 @@ By default, none of these options are set, meaning no transactions will be sent ### Default Sampling Context Data -The information contained in the object passed to the when a transaction is created varies by platform and integration. +The information contained in the object passed to the when a transaction is created varies by integration. diff --git a/docs/platforms/php/common/data-management/sensitive-data/index.mdx b/docs/platforms/php/common/data-management/sensitive-data/index.mdx index f06150b89cbdd9..b75989aa3be6bb 100644 --- a/docs/platforms/php/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/php/common/data-management/sensitive-data/index.mdx @@ -19,7 +19,7 @@ These are some great examples for data scrubbing that every company should think We offer the following options depending on your legal and operational needs: -- filtering or scrubbing sensitive data within the SDK, so that data is _not sent to_ Sentry. Different SDKs have different capabilities, and configuration changes require a redeployment of your application. +- filtering or scrubbing sensitive data within the SDK, so that data is _not sent to_ Sentry. Configuration changes require a redeployment of your application. - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. @@ -27,13 +27,11 @@ We offer the following options depending on your legal and operational needs: Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. -If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - ## Personally Identifiable Information (PII) -Our newer SDKs do not purposefully send PII to stay on the safe side. This behavior is controlled by an option called [`send-default-pii`](../../configuration/options/#send-default-pii). +The SDK purposefully does not send PII to stay on the safe side. This behavior is controlled by an option called [`send-default-pii`](../../configuration/options/#send-default-pii). Turning this option on is required for certain features in Sentry to work, but also means you will need to be even more careful about what data is being sent to Sentry (using the options below). @@ -43,7 +41,7 @@ If you _do not_ wish to use the default PII behavior, you can also choose to ide ### & -SDKs provide a hook, which is invoked before an error or message event is sent and can be used to modify event data to remove sensitive information. Some SDKs also provide a hook which does the same thing for transactions. We recommend using and in the SDKs to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment. +The SDK provides a hook, which is invoked before an error or message event is sent and can be used to modify event data to remove sensitive information. The SDK also provide a hook which does the same thing for transactions. We recommend using and in the SDK to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment. diff --git a/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx index 0770caef65c398..59f673f0974981 100644 --- a/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx @@ -21,7 +21,7 @@ Manually record a breadcrumb: -The available breadcrumb keys are `type`, `category`, `message`, `level`, `timestamp` (which many SDKs will set automatically for you), and `data`, which is the place to put any additional information you'd like the breadcrumb to include. Using keys other than these six won't cause an error, but will result in the data being dropped when the event is processed by Sentry. +The available breadcrumb keys are `type`, `category`, `message`, `level`, `timestamp` (which defaults to the system's wall-clock time), and `data`, which is the place to put any additional information you'd like the breadcrumb to include. Using keys other than these six won't cause an error, but will result in the data being dropped when the event is processed by Sentry. ## Automatic Breadcrumbs @@ -31,7 +31,7 @@ The available breadcrumb keys are `type`, `category`, `message`, `level`, `times SDKs allow you to customize breadcrumbs through the hook. -This hook is passed an already assembled breadcrumb and, in some SDKs, an optional hint. The function can modify the breadcrumb or decide to discard it entirely by returning `null`: +This hook is passed an already assembled breadcrumb and a `hint` object containing extra metadata. The function can modify the breadcrumb or decide to discard it entirely by returning `null`: diff --git a/docs/platforms/php/common/enriching-events/context/index.mdx b/docs/platforms/php/common/enriching-events/context/index.mdx index 36da3d54f75935..e71058c2634d2e 100644 --- a/docs/platforms/php/common/enriching-events/context/index.mdx +++ b/docs/platforms/php/common/enriching-events/context/index.mdx @@ -29,7 +29,7 @@ Learn more about conventions for common contexts in the [contexts interface deve When sending context, _consider payload size limits_. Sentry does not recommend sending the entire application state and large data blobs in contexts. If you exceed the maximum payload size, Sentry will respond with HTTP error `413 Payload Too Large` and reject the event. -The Sentry SDK will try its best to accommodate the data you send and trim large context payloads. Some SDKs can truncate parts of the event; for more details, see the [developer documentation on SDK data handling](https://develop.sentry.dev/sdk/expected-features/data-handling/). +The Sentry SDK will try its best to accommodate the data you send and trim large context payloads. The SDK can truncate parts of the event; for more details, see the [developer documentation on SDK data handling](https://develop.sentry.dev/sdk/expected-features/data-handling/). ## Additional Data diff --git a/docs/platforms/php/common/enriching-events/identify-user/index.mdx b/docs/platforms/php/common/enriching-events/identify-user/index.mdx index 144d515839a7be..662f6a9b0daca8 100644 --- a/docs/platforms/php/common/enriching-events/identify-user/index.mdx +++ b/docs/platforms/php/common/enriching-events/identify-user/index.mdx @@ -30,7 +30,7 @@ An alternative, or addition, to the username. Sentry is aware of email addresses ### `ip_address` The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user. -Serverside SDKs that instrument incoming requests will attempt to pull the IP address from the HTTP request data (`request.env.REMOTE_ADDR` field in JSON), if available. That might require set to `true` in the SDK options. +The SDK will attempt to pull the IP address from the HTTP request data on incoming requests (`request.env.REMOTE_ADDR` field in JSON), if available. That requires set to `true` in the SDK options. If the field is omitted, the default value is `null`. diff --git a/docs/platforms/php/common/usage/sdk-fingerprinting/index.mdx b/docs/platforms/php/common/usage/sdk-fingerprinting/index.mdx index 9bc4a4d4b772c0..a7b2e0dbca5cf3 100644 --- a/docs/platforms/php/common/usage/sdk-fingerprinting/index.mdx +++ b/docs/platforms/php/common/usage/sdk-fingerprinting/index.mdx @@ -11,7 +11,7 @@ By default, Sentry will run one of our built-in grouping algorithms to generate 1. In your SDK, using SDK Fingerprinting, as documented below 2. In your project, using [Fingerprint Rules](/concepts/data-management/event-grouping/fingerprint-rules/) or [Stack Trace Rules](/concepts/data-management/event-grouping/stack-trace-rules/) -In supported SDKs, you can override Sentry's default grouping that passes the fingerprint attribute as an array of strings. The length of a fingerprint's array is not restricted. This works similarly to the [fingerprint rules functionality](/concepts/data-management/event-grouping/fingerprint-rules/), which is always available and can achieve similar results. +You can override Sentry's default grouping that passes the fingerprint attribute as an array of strings. The length of a fingerprint's array is not restricted. This works similarly to the [fingerprint rules functionality](/concepts/data-management/event-grouping/fingerprint-rules/), which can achieve similar results. ## Basic Example diff --git a/docs/platforms/php/guides/laravel/enriching-events/identify-user/index.mdx b/docs/platforms/php/guides/laravel/enriching-events/identify-user/index.mdx index 6d36076bc7cc84..1106464c105f50 100644 --- a/docs/platforms/php/guides/laravel/enriching-events/identify-user/index.mdx +++ b/docs/platforms/php/guides/laravel/enriching-events/identify-user/index.mdx @@ -54,7 +54,7 @@ An alternative, or addition, to the username. Sentry is aware of email addresses ### `ip_address` The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user. -Serverside SDKs that instrument incoming requests will attempt to pull the IP address from the HTTP request data (`request.env.REMOTE_ADDR` field in JSON), if available. That might require send_default_pii set to `true` in the SDK options. +The SDK will attempt to pull the IP address from the HTTP request data on incoming requests (`request.env.REMOTE_ADDR` field in JSON), if available. That requires set to `true` in the SDK options. If the field is omitted, the default value is `null`.