Skip to content

Commit a808fbb

Browse files
docs: Remove generic references from Java and Kotlin (#15076)
Remove generic references or plural references to SDKs in the Java and Kotlin SDK docs. --------- Co-authored-by: Alexander Dinauer <[email protected]>
1 parent 1154882 commit a808fbb

File tree

18 files changed

+31
-46
lines changed

18 files changed

+31
-46
lines changed

docs/platforms/java/common/configuration/draining.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ sidebar_order: 70
44
description: "Learn more about the default behavior of our SDK if the application shuts down unexpectedly."
55
---
66

7-
The default behavior of most SDKs is to send out events over the network
8-
asynchronously in the background. This means that some events might be lost if the application shuts down unexpectedly. The SDKs provide mechanisms to cope with this.
7+
By default the SDK sends out events over the network on a background thread. This means that some events might be lost if the application shuts down unexpectedly. The SDK provides mechanisms to cope with this.
98

109
<PlatformContent includePath="configuration/drain-example" />

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Typically, a `hint` holds the original exception so that additional data can be
3838

3939
<PlatformContent includePath="configuration/before-send-hint" />
4040

41-
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).
41+
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 (<PlatformIdentifier name="before-send" />, <PlatformIdentifier name="before-breadcrumb" /> and event processors).
4242

4343
### Using Hints
4444

@@ -51,7 +51,7 @@ Event and breadcrumb `hints` are objects containing various information used to
5151

5252
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.
5353

54-
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.
54+
For breadcrumbs, the use of `hints` depends on the type of breadcrumb.
5555

5656
<PlatformContent includePath="configuration/before-send-fingerprint">
5757

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

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,6 @@ Note that enabling this option may increase the payload size of events sent to S
102102

103103
If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.
104104

105-
<Alert>
106-
107-
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.
108-
109-
</Alert>
110-
111105
This option is turned off by default.
112106

113107
If you enable this option, be sure to manually remove what you don't want to send using our features for managing [_Sensitive Data_](../../data-management/sensitive-data/).
@@ -204,21 +198,21 @@ These options can be used to hook the SDK in various ways to customize the repor
204198

205199
<ConfigKey name="before-send">
206200

207-
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.
201+
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.
208202

209203
By the time <PlatformIdentifier name="before-send" /> is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.
210204

211205
</ConfigKey>
212206

213207
<ConfigKey name="before-send-transaction">
214208

215-
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.
209+
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.
216210

217211
</ConfigKey>
218212

219213
<ConfigKey name="before-breadcrumb">
220214

221-
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.
215+
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.
222216
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.
223217

224218
</ConfigKey>
@@ -235,7 +229,7 @@ Transports are used to send events to Sentry. Transports can be customized to so
235229

236230
<ConfigKey name="transport">
237231

238-
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.
232+
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.
239233

240234
</ConfigKey>
241235

@@ -247,7 +241,7 @@ When set, a proxy can be configured that should be used for outbound requests. T
247241

248242
<ConfigKey name="shutdown-timeout-millis">
249243

250-
Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems.
244+
Controls how many seconds to wait before shutting down. The SDK sends events from a background queue. This queue is given a certain amount to drain pending events. The default is two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems.
251245

252246
</ConfigKey>
253247

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

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

6161
### Default Sampling Context Data
6262

63-
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.
63+
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.
6464

6565
<PlatformContent includePath="performance/default-sampling-context" />
6666

docs/platforms/java/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 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 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/java/common/enriching-events/breadcrumbs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Manually record a breadcrumb:
2929

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

32-
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`:
32+
This hook is passed an already assembled breadcrumb and <PlatformLink to="/configuration/filtering/#using-hints">a `hint` object</PlatformLink> containing extra metadata. The function can modify the breadcrumb or decide to discard it entirely by returning `null`:
3333

3434
<PlatformContent includePath="enriching-events/breadcrumbs/before-breadcrumb" />
3535

docs/platforms/java/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/java/common/enriching-events/identify-user/index.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@ An alternative, or addition, to the username. Sentry is aware of email addresses
2222
### `ip_address`
2323

2424
The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user.
25-
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.
25+
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.
2626

27-
If the user's `ip_address` is set to `"{{auto}}"`, Sentry will infer the IP address from the connection between your app and Sentry's server.
28-
29-
If the field is omitted, the default value is `null`. However, due to backwards compatibility concerns, certain platforms (in particular JavaScript) have a different default value for `"{{auto}}"`. SDKs and other clients should not rely on this behavior and should set IP addresses or `"{{auto}}"` explicitly.
27+
If the user's `ip_address` is set to `"{{auto}}"`, Sentry will infer the IP address from the connection between your app and Sentry's server. If the field is omitted, the default value is `null`.
3028

3129
To opt out of storing users' IP addresses in your event data, you can go to your project settings, click on "Security & Privacy", and enable "Prevent Storing of IP Addresses" or use Sentry's [server-side data](/security-legal-pii/scrubbing/) scrubbing to remove `$user.ip_address`. Adding such a rule ultimately overrules any other logic.
3230

docs/platforms/java/common/enriching-events/scopes/index.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
title: Scopes
3-
description: "SDKs will typically automatically manage the scopes for you in the framework integrations. Learn what a scope is and how you can use it to your advantage."
3+
description: "The SDK will in most cases automatically manage the scopes for you in the framework integrations. Learn what a scope is and how you can use it to your advantage."
44
---
55

66
When an event is captured and sent to Sentry, SDKs will merge that event data with extra
7-
information from the current scope. SDKs will typically automatically manage the scopes
8-
for you in the framework integrations and you don't need to think about them. However,
7+
information from the current scope. The SDK will in most cases automatically manage the scopes for you in the framework integrations and you don't need to think about them. However,
98
you should know what a scope is and how you can use it to your advantage.
109

1110
## What's a Scope?

docs/platforms/java/common/enriching-events/scopes/index__v7.x.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
title: Scopes and Hubs
3-
description: "SDKs will typically automatically manage the scopes for you in the framework integrations. Learn what a scope is and how you can use it to your advantage."
3+
description: "The SDK will in most cases automatically manage the scopes for you in the framework integrations. Learn what a scope is and how you can use it to your advantage."
44
---
55

66
When an event is captured and sent to Sentry, SDKs will merge that event data with extra
7-
information from the current scope. SDKs will typically automatically manage the scopes
8-
for you in the framework integrations and you don't need to think about them. However,
7+
information from the current scope. The SDK will in most cases automatically manage the scopes for you in the framework integrations and you don't need to think about them. However,
98
you should know what a scope is and how you can use it for your advantage.
109

1110
## What's a Scope, What's a Hub

0 commit comments

Comments
 (0)