Skip to content

Commit 7c1d675

Browse files
alexander-alderman-webbLitarnus
authored andcommitted
docs: Remove generic references from PHP (#15077)
Remove generic references or plural references to SDKs in the PHP SDK docs. --------- Co-authored-by: Martin Linzmayer <martin.linzmayer@sentry.io>
1 parent 0ef169e commit 7c1d675

File tree

9 files changed

+18
-24
lines changed

9 files changed

+18
-24
lines changed

docs/platforms/php/common/configuration/filtering.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,19 @@ Typically, a `hint` holds the original exception so that additional data can be
3030

3131
<PlatformContent includePath="configuration/before-send-hint" />
3232

33-
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 (<PlatformIdentifier name="before-send" />, <PlatformIdentifier name="before-breadcrumb" /> or the event processor system in the SDK).
33+
When the SDK creates an event 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 (<PlatformIdentifier name="before-send" /> and event processors).
3434

3535
### Using Hints
3636

3737
Hints are available in two places:
3838

39-
1. <PlatformIdentifier name="before-send" /> / <PlatformIdentifier name="before-breadcrumb" />
39+
1. <PlatformIdentifier name="before-send" />
4040
2. `eventProcessors`
4141

42-
Event and breadcrumb `hints` are objects containing various information used to put together an event or a breadcrumb. Typically `hints` hold the original exception so that additional data can be extracted or grouping can be affected.
42+
Event `hints` are objects containing various information used to put together an event or a breadcrumb. Typically `hints` hold the original exception so that additional data can be extracted or grouping can be affected.
4343

4444
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.
4545

46-
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.
47-
4846
<PlatformContent includePath="configuration/before-send-fingerprint">
4947

5048
In this example, the fingerprint is forced to a common value if an exception of a certain type has been caught:

docs/platforms/php/common/configuration/options.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,7 @@ The number of characters after which the values containing text in the event pay
135135

136136
<SdkOption name="before_breadcrumb" type='function (Breadcrumb $breadcrumb): Breadcrumb'>
137137

138-
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.
139-
140-
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.
138+
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.
141139

142140
</SdkOption>
143141

@@ -151,7 +149,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The
151149

152150
<SdkOption name="before_send" type='function (Event $event): Event'>
153151

154-
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.
152+
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.
155153

156154
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.
157155

@@ -205,7 +203,7 @@ A list of strings that match transaction names that shouldn't be sent to Sentry.
205203

206204
<SdkOption name="before_send_transaction" type='function (Event $transaction): Event'>
207205

208-
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.
206+
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.
209207

210208
</SdkOption>
211209

@@ -225,7 +223,7 @@ To disable sending trace data to any downstream service, set this option to an e
225223

226224
<SdkOption name="before_send_check_in" type='function (Event $checkIn): Event'>
227225

228-
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.
226+
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.
229227

230228
</SdkOption>
231229

@@ -239,7 +237,7 @@ This option enables the logging integration, which allows the SDK to capture log
239237

240238
<SdkOption name="before_send_log" type='function (\Sentry\Logs\Log $log): ?\Sentry\Logs\Log'>
241239

242-
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.
240+
This function is called with a log object, and can return a modified log event object, or `null` to skip reporting the event.
243241

244242
</SdkOption>
245243

docs/platforms/php/common/configuration/sampling.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ By default, none of these options are set, meaning no transactions will be sent
5858

5959
### Default Sampling Context Data
6060

61-
The information contained in the <PlatformIdentifier name="sampling-context" /> object passed to the <PlatformIdentifier name="traces-sampler" /> when a transaction is created varies by platform and integration.
61+
The information contained in the <PlatformIdentifier name="sampling-context" /> object passed to the <PlatformIdentifier name="traces-sampler" /> when a transaction is created varies by integration.
6262

6363
<PlatformContent includePath="performance/default-sampling-context" />
6464

docs/platforms/php/common/data-management/sensitive-data/index.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,19 @@ These are some great examples for data scrubbing that every company should think
1919

2020
We offer the following options depending on your legal and operational needs:
2121

22-
- 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.
22+
- filtering or scrubbing sensitive data within the SDK, so that data is _not sent to_ Sentry. Configuration changes require a redeployment of your application.
2323
- [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.
2424
- [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.
2525

2626
<Alert>
2727

2828
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.
2929

30-
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.
31-
3230
</Alert>
3331

3432
## Personally Identifiable Information (PII)
3533

36-
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).
34+
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).
3735

3836
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).
3937

@@ -43,7 +41,7 @@ If you _do not_ wish to use the default PII behavior, you can also choose to ide
4341

4442
### <PlatformIdentifier name="before-send" /> & <PlatformIdentifier name="before-send-transaction" />
4543

46-
SDKs provide a <PlatformIdentifier name="before-send" /> 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 <PlatformIdentifier name="before-send-transaction" /> hook which does the same thing for transactions. We recommend using <PlatformIdentifier name="before-send" /> and <PlatformIdentifier name="before-send-transaction" /> in the SDKs to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment.
44+
The SDK provides a <PlatformIdentifier name="before-send" /> 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 provides a <PlatformIdentifier name="before-send-transaction" /> hook which does the same thing for transactions. We recommend using <PlatformIdentifier name="before-send" /> and <PlatformIdentifier name="before-send-transaction" /> in the SDK to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment.
4745

4846
<PlatformContent includePath="configuration/before-send/" />
4947

docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Manually record a breadcrumb:
2323

2424
<PlatformContent includePath="enriching-events/breadcrumbs/breadcrumbs-example" />
2525

26-
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.
26+
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.
2727

2828
## Automatic Breadcrumbs
2929

@@ -33,7 +33,7 @@ The available breadcrumb keys are `type`, `category`, `message`, `level`, `times
3333

3434
SDKs allow you to customize breadcrumbs through the <PlatformIdentifier name="before-breadcrumb" /> hook.
3535

36-
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`:
36+
This hook is passed an already assembled breadcrumb. The function can modify the breadcrumb or decide to discard it entirely by returning `null`:
3737

3838
<PlatformContent includePath="enriching-events/breadcrumbs/before-breadcrumb" />
3939

docs/platforms/php/common/enriching-events/context/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Learn more about conventions for common contexts in the [contexts interface deve
2929

3030
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.
3131

32-
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/).
32+
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/).
3333

3434
## Additional Data
3535

docs/platforms/php/common/enriching-events/identify-user/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ An alternative, or addition, to the username. Sentry is aware of email addresses
3030
### `ip_address`
3131

3232
The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user.
33-
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 <PlatformIdentifier name="send-default-pii" /> set to `true` in the SDK options.
33+
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 <PlatformIdentifier name="send-default-pii" /> set to `true` in the SDK options.
3434

3535
If the field is omitted, the default value is `null`.
3636

docs/platforms/php/common/usage/sdk-fingerprinting/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ By default, Sentry will run one of our built-in grouping algorithms to generate
1111
1. In your SDK, using SDK Fingerprinting, as documented below
1212
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/)
1313

14-
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.
14+
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.
1515

1616
## Basic Example
1717

docs/platforms/php/guides/laravel/enriching-events/identify-user/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ An alternative, or addition, to the username. Sentry is aware of email addresses
5454
### `ip_address`
5555

5656
The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user.
57-
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 <PlatformLink to="/configuration/options/#send_default_pii">send_default_pii</PlatformLink> set to `true` in the SDK options.
57+
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 <PlatformIdentifier name="send-default-pii" /> set to `true` in the SDK options.
5858

5959
If the field is omitted, the default value is `null`.
6060

0 commit comments

Comments
 (0)