From 7d577e7b0f075a9a4da3882cd1e73b49be60de51 Mon Sep 17 00:00:00 2001 From: Ivana Kellyer Date: Wed, 29 Jan 2025 14:37:55 +0100 Subject: [PATCH] feat(onboarding): Add `send_default_pii=True` to Python onboarding snippets (#84220) As part of https://github.com/getsentry/team-sdks/issues/121 we want to add `send_default_pii=True` to all relevant onboarding snippets for better out-of-the-box debugability. --- static/app/gettingStartedDocs/python/aiohttp.tsx | 5 ++++- static/app/gettingStartedDocs/python/asgi.tsx | 5 ++++- static/app/gettingStartedDocs/python/awslambda.tsx | 3 +++ static/app/gettingStartedDocs/python/bottle.tsx | 5 ++++- static/app/gettingStartedDocs/python/celery.tsx | 5 ++++- static/app/gettingStartedDocs/python/chalice.tsx | 5 ++++- static/app/gettingStartedDocs/python/django.tsx | 5 ++++- static/app/gettingStartedDocs/python/falcon.tsx | 5 ++++- static/app/gettingStartedDocs/python/fastapi.tsx | 5 ++++- static/app/gettingStartedDocs/python/flask.tsx | 5 ++++- static/app/gettingStartedDocs/python/gcpfunctions.tsx | 5 ++++- static/app/gettingStartedDocs/python/mongo.tsx | 3 +++ static/app/gettingStartedDocs/python/pyramid.tsx | 3 +++ static/app/gettingStartedDocs/python/python.tsx | 7 +++++-- static/app/gettingStartedDocs/python/quart.tsx | 5 ++++- static/app/gettingStartedDocs/python/rq.tsx | 5 ++++- static/app/gettingStartedDocs/python/sanic.tsx | 3 +++ static/app/gettingStartedDocs/python/serverless.tsx | 5 ++++- static/app/gettingStartedDocs/python/starlette.tsx | 5 ++++- static/app/gettingStartedDocs/python/tornado.tsx | 5 ++++- static/app/gettingStartedDocs/python/tryton.tsx | 7 ++++--- static/app/gettingStartedDocs/python/wsgi.tsx | 5 ++++- 22 files changed, 85 insertions(+), 21 deletions(-) diff --git a/static/app/gettingStartedDocs/python/aiohttp.tsx b/static/app/gettingStartedDocs/python/aiohttp.tsx index f43ed88f14f9f4..b41fa8ea16357e 100644 --- a/static/app/gettingStartedDocs/python/aiohttp.tsx +++ b/static/app/gettingStartedDocs/python/aiohttp.tsx @@ -28,7 +28,10 @@ from aiohttp import web import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/asgi.tsx b/static/app/gettingStartedDocs/python/asgi.tsx index 8a8e79133415ab..4ae4fe5fa40904 100644 --- a/static/app/gettingStartedDocs/python/asgi.tsx +++ b/static/app/gettingStartedDocs/python/asgi.tsx @@ -26,7 +26,10 @@ from sentry_sdk.integrations.asgi import SentryAsgiMiddleware from myapp import asgi_app sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/awslambda.tsx b/static/app/gettingStartedDocs/python/awslambda.tsx index 32ced0c3734261..9a433477da2029 100644 --- a/static/app/gettingStartedDocs/python/awslambda.tsx +++ b/static/app/gettingStartedDocs/python/awslambda.tsx @@ -34,6 +34,9 @@ from sentry_sdk.integrations.aws_lambda import AwsLambdaIntegration sentry_sdk.init( dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True, integrations=[AwsLambdaIntegration()],${ params.isPerformanceSelected ? ` diff --git a/static/app/gettingStartedDocs/python/bottle.tsx b/static/app/gettingStartedDocs/python/bottle.tsx index a12dadd52a9375..f9cca35a709e2a 100644 --- a/static/app/gettingStartedDocs/python/bottle.tsx +++ b/static/app/gettingStartedDocs/python/bottle.tsx @@ -26,7 +26,10 @@ const getSdkSetupSnippet = (params: Params) => ` import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/celery.tsx b/static/app/gettingStartedDocs/python/celery.tsx index b1511aef294d8b..fe6c1474b1f538 100644 --- a/static/app/gettingStartedDocs/python/celery.tsx +++ b/static/app/gettingStartedDocs/python/celery.tsx @@ -27,7 +27,10 @@ const getSdkSetupSnippet = (params: Params) => ` import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/chalice.tsx b/static/app/gettingStartedDocs/python/chalice.tsx index e1ecdd76bb6718..b7c24bba674c29 100644 --- a/static/app/gettingStartedDocs/python/chalice.tsx +++ b/static/app/gettingStartedDocs/python/chalice.tsx @@ -24,7 +24,10 @@ from sentry_sdk.integrations.chalice import ChaliceIntegration sentry_sdk.init( dsn="${params.dsn.public}", - integrations=[ChaliceIntegration()],${ + integrations=[ChaliceIntegration()], + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/django.tsx b/static/app/gettingStartedDocs/python/django.tsx index 89f1bd4e03deb5..9319068cedec77 100644 --- a/static/app/gettingStartedDocs/python/django.tsx +++ b/static/app/gettingStartedDocs/python/django.tsx @@ -26,7 +26,10 @@ const getSdkSetupSnippet = (params: Params) => ` import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/falcon.tsx b/static/app/gettingStartedDocs/python/falcon.tsx index 05efcbb651307b..4f5380c2a51f9a 100644 --- a/static/app/gettingStartedDocs/python/falcon.tsx +++ b/static/app/gettingStartedDocs/python/falcon.tsx @@ -27,7 +27,10 @@ import falcon import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/fastapi.tsx b/static/app/gettingStartedDocs/python/fastapi.tsx index 6fe895e6b88a02..24403afa0dec44 100644 --- a/static/app/gettingStartedDocs/python/fastapi.tsx +++ b/static/app/gettingStartedDocs/python/fastapi.tsx @@ -29,7 +29,10 @@ from fastapi import FastAPI import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/flask.tsx b/static/app/gettingStartedDocs/python/flask.tsx index 85424ad7db2263..1a446743f0e916 100644 --- a/static/app/gettingStartedDocs/python/flask.tsx +++ b/static/app/gettingStartedDocs/python/flask.tsx @@ -29,7 +29,10 @@ import sentry_sdk from flask import Flask sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/gcpfunctions.tsx b/static/app/gettingStartedDocs/python/gcpfunctions.tsx index e1f46b397cb068..1bddf717d0e1ce 100644 --- a/static/app/gettingStartedDocs/python/gcpfunctions.tsx +++ b/static/app/gettingStartedDocs/python/gcpfunctions.tsx @@ -28,7 +28,10 @@ from sentry_sdk.integrations.gcp import GcpIntegration sentry_sdk.init( dsn="${params.dsn.public}", - integrations=[GcpIntegration()],${ + integrations=[GcpIntegration()], + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/mongo.tsx b/static/app/gettingStartedDocs/python/mongo.tsx index aa34e751e731e0..62567062683b9b 100644 --- a/static/app/gettingStartedDocs/python/mongo.tsx +++ b/static/app/gettingStartedDocs/python/mongo.tsx @@ -22,6 +22,9 @@ sentry_sdk.init( PyMongoIntegration(), ], + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True, # Set traces_sample_rate to 1.0 to capture 100% # of transactions for tracing. # We recommend adjusting this value in production, diff --git a/static/app/gettingStartedDocs/python/pyramid.tsx b/static/app/gettingStartedDocs/python/pyramid.tsx index 7e76da11a97790..f01158e239e598 100644 --- a/static/app/gettingStartedDocs/python/pyramid.tsx +++ b/static/app/gettingStartedDocs/python/pyramid.tsx @@ -26,6 +26,9 @@ import sentry_sdk sentry_sdk.init( dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True, ) `; diff --git a/static/app/gettingStartedDocs/python/python.tsx b/static/app/gettingStartedDocs/python/python.tsx index cc01b624d87f45..49161bfea421b8 100644 --- a/static/app/gettingStartedDocs/python/python.tsx +++ b/static/app/gettingStartedDocs/python/python.tsx @@ -47,7 +47,10 @@ const getSdkSetupSnippet = (params: Params) => ` import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% @@ -192,7 +195,7 @@ import sentry_sdk sentry_sdk.init( dsn="${params.dsn.public}", - enable_tracing=True, + traces_sample_rate=1.0, )`, additionalInfo: tct( 'Learn more about tracing [linkTracingOptions:options], how to use the [linkTracesSampler:traces_sampler] function, or how to [linkSampleTransactions:sample transactions].', diff --git a/static/app/gettingStartedDocs/python/quart.tsx b/static/app/gettingStartedDocs/python/quart.tsx index d6ed372a36b80b..1d4fcc18459122 100644 --- a/static/app/gettingStartedDocs/python/quart.tsx +++ b/static/app/gettingStartedDocs/python/quart.tsx @@ -29,7 +29,10 @@ from quart import Quart sentry_sdk.init( dsn="${params.dsn.public}", - integrations=[QuartIntegration()],${ + integrations=[QuartIntegration()], + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/rq.tsx b/static/app/gettingStartedDocs/python/rq.tsx index 41a9f335be6ca7..91ebfd5f7b66e0 100644 --- a/static/app/gettingStartedDocs/python/rq.tsx +++ b/static/app/gettingStartedDocs/python/rq.tsx @@ -20,7 +20,10 @@ const getInstallSnippet = () => `pip install --upgrade 'sentry-sdk[rq]'`; const getInitCallSnippet = (params: Params) => ` sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/sanic.tsx b/static/app/gettingStartedDocs/python/sanic.tsx index 3c5c982c9e419c..b2862f332be315 100644 --- a/static/app/gettingStartedDocs/python/sanic.tsx +++ b/static/app/gettingStartedDocs/python/sanic.tsx @@ -25,6 +25,9 @@ import sentry_sdk sentry_sdk.init( dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True, ) `; diff --git a/static/app/gettingStartedDocs/python/serverless.tsx b/static/app/gettingStartedDocs/python/serverless.tsx index 14b23acb0107cb..b6d62e412a24ef 100644 --- a/static/app/gettingStartedDocs/python/serverless.tsx +++ b/static/app/gettingStartedDocs/python/serverless.tsx @@ -24,7 +24,10 @@ import sentry_sdk from sentry_sdk.integrations.serverless import serverless_function sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/starlette.tsx b/static/app/gettingStartedDocs/python/starlette.tsx index 0c2984225462a1..bc55a32e58ef75 100644 --- a/static/app/gettingStartedDocs/python/starlette.tsx +++ b/static/app/gettingStartedDocs/python/starlette.tsx @@ -27,7 +27,10 @@ from starlette.applications import Starlette import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/tornado.tsx b/static/app/gettingStartedDocs/python/tornado.tsx index 7839aa2f4bd992..dd288d6f1ac268 100644 --- a/static/app/gettingStartedDocs/python/tornado.tsx +++ b/static/app/gettingStartedDocs/python/tornado.tsx @@ -26,7 +26,10 @@ const getSdkSetupSnippet = (params: Params) => ` import sentry_sdk sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/tryton.tsx b/static/app/gettingStartedDocs/python/tryton.tsx index dd270dcc54cfd2..72f247d2402bfc 100644 --- a/static/app/gettingStartedDocs/python/tryton.tsx +++ b/static/app/gettingStartedDocs/python/tryton.tsx @@ -19,9 +19,10 @@ from sentry_sdk.integrations.trytond import TrytondWSGIIntegration sentry_sdk.init( dsn="${params.dsn.public}", - integrations:[ - sentry_sdk.integrations.trytond.TrytondWSGIIntegration(), - ],${ + integrations=[TrytondWSGIIntegration()], + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% diff --git a/static/app/gettingStartedDocs/python/wsgi.tsx b/static/app/gettingStartedDocs/python/wsgi.tsx index 4796808a127645..bd0b5a4d4e7313 100644 --- a/static/app/gettingStartedDocs/python/wsgi.tsx +++ b/static/app/gettingStartedDocs/python/wsgi.tsx @@ -26,7 +26,10 @@ from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware from my_wsgi_app import app sentry_sdk.init( - dsn="${params.dsn.public}",${ + dsn="${params.dsn.public}", + # Add data like request headers and IP for users, + # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info + send_default_pii=True,${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100%