diff --git a/docs/contributing/pages/components.mdx b/docs/contributing/pages/components.mdx index ce393ffd7792d6..e3a1dc5d7c2d3f 100644 --- a/docs/contributing/pages/components.mdx +++ b/docs/contributing/pages/components.mdx @@ -445,6 +445,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for performance monitoring. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/common/data-management/data-collected.mdx b/docs/platforms/go/common/data-management/data-collected.mdx new file mode 100644 index 00000000000000..f28cfaf83cb856 --- /dev/null +++ b/docs/platforms/go/common/data-management/data-collected.mdx @@ -0,0 +1,37 @@ +--- +title: Data Collected +description: "See what data is collected by the Sentry SDK." +sidebar_order: 1 +--- + +Sentry takes data privacy very seriously and has default settings in place that prioritize data safety, especially when it comes to personally identifiable information (PII) data. When you add the Sentry SDK to your application, you allow it to collect data and send it to Sentry during the runtime of your application. + +The category types and amount of data collected vary, depending on the integrations you've enabled in the Sentry SDK. This page lists data categories that the Sentry Go SDK collects. + +For many of the categories listed here it is required to enable the SendDefaultPII option. + +## HTTP Headers + +By default, the Sentry SDK doesn't send any HTTP headers. Even when sending HTTP headers is enabled, we have a [denylist](https://github.com/getsentry/sentry-go/blob/master/interfaces.go#L157-163) in place, which filters out any headers that contain sensitive data. + +To start sending HTTP headers, set SendDefaultPII option to true. + +## Cookies + +By default, the Sentry SDK doesn't send cookies. Sentry tries to remove any cookies that contain sensitive information, such as the Session ID and CSRF Token cookies. + +If you want to send cookies, set SendDefaultPII option to true. + +## Users' IP Addresses + +By default, the Sentry SDK doesn't send the user's IP address. Once enabled, the Sentry backend services will infer the user ip address based on the incoming request, unless certain integrations you can enable override this behavior. + +To enable sending the user's IP address, set SendDefaultPII option to true. + +## Request URL + +The full request URL of incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data. + +## Request Query String + +The full request query string of incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data. diff --git a/docs/platforms/go/common/migration.mdx b/docs/platforms/go/common/migration.mdx index c10d0e0bc0b5ae..eba38b3c3675cb 100644 --- a/docs/platforms/go/common/migration.mdx +++ b/docs/platforms/go/common/migration.mdx @@ -44,6 +44,9 @@ import ( func main() { err := sentry.Init(sentry.ClientOptions{ Dsn: "___PUBLIC_DSN___", + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }) if err != nil { diff --git a/docs/platforms/go/guides/echo/index.mdx b/docs/platforms/go/guides/echo/index.mdx index 1c27ffb2d184f1..7740fefdea4ac6 100644 --- a/docs/platforms/go/guides/echo/index.mdx +++ b/docs/platforms/go/guides/echo/index.mdx @@ -47,6 +47,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for tracing. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/guides/fasthttp/index.mdx b/docs/platforms/go/guides/fasthttp/index.mdx index a5fa11c17af5fa..5a340ab08b0c33 100644 --- a/docs/platforms/go/guides/fasthttp/index.mdx +++ b/docs/platforms/go/guides/fasthttp/index.mdx @@ -46,6 +46,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for tracing. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/guides/fiber/index.mdx b/docs/platforms/go/guides/fiber/index.mdx index 2e98cf15d84c5d..247d9e43ec9c3c 100644 --- a/docs/platforms/go/guides/fiber/index.mdx +++ b/docs/platforms/go/guides/fiber/index.mdx @@ -35,6 +35,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for performance monitoring. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/guides/gin/index.mdx b/docs/platforms/go/guides/gin/index.mdx index f35253137aef6b..2528835c4a546b 100644 --- a/docs/platforms/go/guides/gin/index.mdx +++ b/docs/platforms/go/guides/gin/index.mdx @@ -47,6 +47,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for tracing. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/guides/http/index.mdx b/docs/platforms/go/guides/http/index.mdx index a8beaaeca9f4e9..42d8ff3a2d4c4e 100644 --- a/docs/platforms/go/guides/http/index.mdx +++ b/docs/platforms/go/guides/http/index.mdx @@ -46,6 +46,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for tracing. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/guides/iris/index.mdx b/docs/platforms/go/guides/iris/index.mdx index 9fbed145bbb963..03326cfa6ea865 100644 --- a/docs/platforms/go/guides/iris/index.mdx +++ b/docs/platforms/go/guides/iris/index.mdx @@ -46,6 +46,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for tracing. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/guides/negroni/index.mdx b/docs/platforms/go/guides/negroni/index.mdx index 33921ba34806a4..e0e45eddd63e07 100644 --- a/docs/platforms/go/guides/negroni/index.mdx +++ b/docs/platforms/go/guides/negroni/index.mdx @@ -47,6 +47,9 @@ if err := sentry.Init(sentry.ClientOptions{ // of transactions for tracing. // We recommend adjusting this value in production, TracesSampleRate: 1.0, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }); err != nil { fmt.Printf("Sentry initialization failed: %v\n", err) } diff --git a/docs/platforms/go/guides/slog/index.mdx b/docs/platforms/go/guides/slog/index.mdx index f5fa91b17a2689..fdb47e5bd70783 100644 --- a/docs/platforms/go/guides/slog/index.mdx +++ b/docs/platforms/go/guides/slog/index.mdx @@ -42,6 +42,9 @@ func main() { err := sentry.Init(sentry.ClientOptions{ Dsn: "___PUBLIC_DSN___", EnableTracing: false, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }) if err != nil { log.Fatal(err) diff --git a/docs/platforms/go/guides/zerolog/index.mdx b/docs/platforms/go/guides/zerolog/index.mdx index ce490a6599e675..c05cc58d927c97 100644 --- a/docs/platforms/go/guides/zerolog/index.mdx +++ b/docs/platforms/go/guides/zerolog/index.mdx @@ -42,6 +42,9 @@ func main() { // Initialize Sentry err := sentry.Init(sentry.ClientOptions{ Dsn: "___PUBLIC_DSN___", + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event { // Modify or filter events before sending them to Sentry return event diff --git a/platform-includes/getting-started-config/go.mdx b/platform-includes/getting-started-config/go.mdx index b9f85f59879577..08517287f741be 100644 --- a/platform-includes/getting-started-config/go.mdx +++ b/platform-includes/getting-started-config/go.mdx @@ -14,6 +14,9 @@ func main() { // Enable printing of SDK debug messages. // Useful when getting started or trying to figure something out. Debug: true, + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }) if err != nil { log.Fatalf("sentry.Init: %s", err) diff --git a/platform-includes/getting-started-verify/go.mdx b/platform-includes/getting-started-verify/go.mdx index 4bc783508c1d98..fbffe5ef874ab5 100644 --- a/platform-includes/getting-started-verify/go.mdx +++ b/platform-includes/getting-started-verify/go.mdx @@ -11,6 +11,9 @@ import ( func main() { err := sentry.Init(sentry.ClientOptions{ Dsn: "___PUBLIC_DSN___", + // Adds request headers and IP for users, + // visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info + SendDefaultPII: true, }) if err != nil { log.Fatalf("sentry.Init: %s", err)