From d628ef28d218d131fd577456045e403fac47a756 Mon Sep 17 00:00:00 2001 From: Alexander Alderman Webb Date: Tue, 30 Sep 2025 14:40:14 +0200 Subject: [PATCH 1/2] docs: Remove generic references from go --- docs/platforms/go/common/configuration/draining.mdx | 3 +-- docs/platforms/go/common/configuration/filtering.mdx | 4 ++-- docs/platforms/go/common/configuration/sampling.mdx | 2 +- .../go/common/data-management/sensitive-data/index.mdx | 6 ++---- .../go/common/enriching-events/breadcrumbs/index.mdx | 2 +- docs/platforms/go/common/enriching-events/context/index.mdx | 2 +- .../go/common/enriching-events/identify-user/index.mdx | 6 ++---- docs/platforms/go/common/enriching-events/scopes/index.mdx | 5 ++--- docs/platforms/go/common/usage/sdk-fingerprinting/index.mdx | 2 +- 9 files changed, 13 insertions(+), 19 deletions(-) diff --git a/docs/platforms/go/common/configuration/draining.mdx b/docs/platforms/go/common/configuration/draining.mdx index 7ed1a445a6f2a5..82b66fbd487bde 100644 --- a/docs/platforms/go/common/configuration/draining.mdx +++ b/docs/platforms/go/common/configuration/draining.mdx @@ -4,7 +4,6 @@ sidebar_order: 70 description: "Learn more about the default behavior of our SDK if the application shuts down unexpectedly." --- -The default behavior of most SDKs is to send out events over the network -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. +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. diff --git a/docs/platforms/go/common/configuration/filtering.mdx b/docs/platforms/go/common/configuration/filtering.mdx index b16dff6ce0cfd3..f5fbbca855c1b7 100644 --- a/docs/platforms/go/common/configuration/filtering.mdx +++ b/docs/platforms/go/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/go/common/configuration/sampling.mdx b/docs/platforms/go/common/configuration/sampling.mdx index e714c315cfb2b9..77537d5ad742e5 100644 --- a/docs/platforms/go/common/configuration/sampling.mdx +++ b/docs/platforms/go/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/go/common/data-management/sensitive-data/index.mdx b/docs/platforms/go/common/data-management/sensitive-data/index.mdx index 10a33925792646..06aa66b62698ab 100644 --- a/docs/platforms/go/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/go/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,8 +27,6 @@ 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. - If you _do not_ wish to use the default PII behavior, you can also choose to identify users in a more controlled manner, using our [user identity context](../../enriching-events/identify-user/). @@ -37,7 +35,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/go/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx index 8c0e4e7c0e248d..e641b9155d5315 100644 --- a/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx @@ -29,7 +29,7 @@ Manually record a breadcrumb: 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/go/common/enriching-events/context/index.mdx b/docs/platforms/go/common/enriching-events/context/index.mdx index 36da3d54f75935..e71058c2634d2e 100644 --- a/docs/platforms/go/common/enriching-events/context/index.mdx +++ b/docs/platforms/go/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/go/common/enriching-events/identify-user/index.mdx b/docs/platforms/go/common/enriching-events/identify-user/index.mdx index a4f226cc9b2385..accf2e19336d61 100644 --- a/docs/platforms/go/common/enriching-events/identify-user/index.mdx +++ b/docs/platforms/go/common/enriching-events/identify-user/index.mdx @@ -26,11 +26,9 @@ 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 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`. 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. +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`. 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. diff --git a/docs/platforms/go/common/enriching-events/scopes/index.mdx b/docs/platforms/go/common/enriching-events/scopes/index.mdx index 5acfede50d7951..539f28da88154e 100644 --- a/docs/platforms/go/common/enriching-events/scopes/index.mdx +++ b/docs/platforms/go/common/enriching-events/scopes/index.mdx @@ -1,11 +1,10 @@ --- title: Scopes and Hubs -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." +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." --- When an event is captured and sent to Sentry, SDKs will merge that event data with extra -information from the current scope. SDKs will typically automatically manage the scopes -for you in the framework integrations and you don't need to think about them. However, +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, you should know what a scope is and how you can use it for your advantage. ## What's a Scope, What's a Hub diff --git a/docs/platforms/go/common/usage/sdk-fingerprinting/index.mdx b/docs/platforms/go/common/usage/sdk-fingerprinting/index.mdx index 9bc4a4d4b772c0..a7b2e0dbca5cf3 100644 --- a/docs/platforms/go/common/usage/sdk-fingerprinting/index.mdx +++ b/docs/platforms/go/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 From d84352feb7ef78f824e8e6dd2beb06f791d709c5 Mon Sep 17 00:00:00 2001 From: Giannis Gkiortzis Date: Wed, 1 Oct 2025 10:56:29 +0200 Subject: [PATCH 2/2] fix: change go specific parts --- docs/platforms/go/common/configuration/draining.mdx | 2 +- docs/platforms/go/common/configuration/filtering.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/go/common/configuration/draining.mdx b/docs/platforms/go/common/configuration/draining.mdx index 82b66fbd487bde..453b130ee8fe1c 100644 --- a/docs/platforms/go/common/configuration/draining.mdx +++ b/docs/platforms/go/common/configuration/draining.mdx @@ -4,6 +4,6 @@ sidebar_order: 70 description: "Learn more about the default behavior of our SDK if the application shuts down unexpectedly." --- -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. +By default, the SDK uses an asynchronous transport running in its own separate goroutine to send events over the network. As a result, some events may be lost if the application shuts down unexpectedly. The SDK provides mechanisms to handle this scenario. diff --git a/docs/platforms/go/common/configuration/filtering.mdx b/docs/platforms/go/common/configuration/filtering.mdx index f5fbbca855c1b7..a5bf49e5e9f0bb 100644 --- a/docs/platforms/go/common/configuration/filtering.mdx +++ b/docs/platforms/go/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, the SDK sends these objects to certain callbacks (, and event processors). +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 error instance. For better customization, the SDK sends these objects to certain callbacks (, and event processors). ### Using Hints