chore(profiling): Update python profiling docs for new SDK #85560

Zylphrex · 2025-02-20T18:39:05Z

This uses the updated python sdk where

_experiments["continuous_profiling_auto_start"] is replaced by profile_lifecycle
- this differs slightly to only profile traces instead of all the time

This uses the updated python sdk where - `start_profiler` is replaced by `start_profile_session` - `stop_profiler` is replaced by `stop_profiler_session` - `_experiments["continuous_profiling_auto_start"]` is replaced by `profile_lifecycle` - this differs slightly to only profile traces instead of all the time

Zylphrex · 2025-02-20T18:40:48Z

Need to wait until getsentry/sentry-python #4079 is in a release

Rename to profile_session_sample_rate introduced in https://github.com/getsentry/sentry-python/pull/4002/files

…or-new-sdk

codecov · 2025-03-17T14:07:58Z

❌ 28 Tests Failed:

Tests completed	Failed	Passed	Skipped
10046	28	10018	11

View the top 3 failed test(s) by shortest run time

tryton onboarding docs renders continuous profiling

Stack Traces | 0.027s run time

Error: expect(element).not.toBeInTheDocument()

expected document not to contain element, found <code class="language-python css-3u28qi-Code ekl9mf40">import sentry_sdk
from sentry_sdk.integrations.trytond import TrytondWSGIIntegration

sentry_sdk.init(
    dsn="test-dsn",
    integrations=[TrytondWSGIIntegration()],
    # Add data like request headers and IP for users,
    # see https://docs.sentry..../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.
    traces_sample_rate=1.0,
    # Set profile_session_sample_rate to 1.0 to profile 100%
    # of profile sessions.
    profile_session_sample_rate=1.0,
    # Set profile_lifecycle to "trace" to automatically
    # run the profiler on when there is an active transaction
    profile_lifecycle="trace",
)

from trytond.application import app as application

# ...</code> instead
    at Object.<anonymous> (.../gettingStartedDocs/python/tryton.spec.tsx:48:129)
    at Promise.then.completed (.../jest-circus/build/utils.js:298:28)
    at new Promise (<anonymous>)
    at callAsyncCircusFn (.../jest-circus/build/utils.js:231:10)
    at _callCircusTest (.../jest-circus/build/run.js:316:40)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at _runTest (.../jest-circus/build/run.js:252:3)
    at _runTestsForDescribeBlock (.../jest-circus/build/run.js:126:9)
    at _runTestsForDescribeBlock (.../jest-circus/build/run.js:121:9)
    at run (.../jest-circus/build/run.js:71:3)
    at runAndTransformResultsToJestFormat (.../build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)
    at jestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:19)
    at runTestInternal (.../jest-runner/build/runTest.js:367:16)
    at runTest (.../jest-runner/build/runTest.js:444:34)
    at Object.worker (.../jest-runner/build/testWorker.js:106:12)

chalice onboarding docs renders continuous profiling

Stack Traces | 0.034s run time

Error: expect(element).not.toBeInTheDocument()

expected document not to contain element, found <code class="language-python css-3u28qi-Code ekl9mf40">import sentry_sdk
from chalice import Chalice

from sentry_sdk.integrations.chalice import ChaliceIntegration

sentry_sdk.init(
    dsn="test-dsn",
    integrations=[ChaliceIntegration()],
    # Add data like request headers and IP for users,
    # see https://docs.sentry..../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.
    traces_sample_rate=1.0,
    # Set profile_session_sample_rate to 1.0 to profile 100%
    # of profile sessions.
    profile_session_sample_rate=1.0,
    # Set profile_lifecycle to "trace" to automatically
    # run the profiler on when there is an active transaction
    profile_lifecycle="trace",
)

app = Chalice(app_name="appname")</code> instead
    at Object.<anonymous> (.../gettingStartedDocs/python/chalice.spec.tsx:57:129)
    at Promise.then.completed (.../jest-circus/build/utils.js:298:28)
    at new Promise (<anonymous>)
    at callAsyncCircusFn (.../jest-circus/build/utils.js:231:10)
    at _callCircusTest (.../jest-circus/build/run.js:316:40)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at _runTest (.../jest-circus/build/run.js:252:3)
    at _runTestsForDescribeBlock (.../jest-circus/build/run.js:126:9)
    at _runTestsForDescribeBlock (.../jest-circus/build/run.js:121:9)
    at run (.../jest-circus/build/run.js:71:3)
    at runAndTransformResultsToJestFormat (.../build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)
    at jestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:19)
    at runTestInternal (.../jest-runner/build/runTest.js:367:16)
    at runTest (.../jest-runner/build/runTest.js:444:34)
    at Object.worker (.../jest-runner/build/testWorker.js:106:12)

django onboarding docs renders continuous profiling

Stack Traces | 0.036s run time

Error: expect(element).not.toBeInTheDocument()

expected document not to contain element, found <code class="language-python css-3u28qi-Code ekl9mf40">import sentry_sdk

sentry_sdk.init(
    dsn="test-dsn",
    # Add data like request headers and IP for users,
    # see https://docs.sentry..../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.
    traces_sample_rate=1.0,
    # Set profile_session_sample_rate to 1.0 to profile 100%
    # of profile sessions.
    profile_session_sample_rate=1.0,
    # Set profile_lifecycle to "trace" to automatically
    # run the profiler on when there is an active transaction
    profile_lifecycle="trace",
)</code> instead
    at Object.<anonymous> (.../gettingStartedDocs/python/django.spec.tsx:57:129)
    at Promise.then.completed (.../jest-circus/build/utils.js:298:28)
    at new Promise (<anonymous>)
    at callAsyncCircusFn (.../jest-circus/build/utils.js:231:10)
    at _callCircusTest (.../jest-circus/build/run.js:316:40)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at _runTest (.../jest-circus/build/run.js:252:3)
    at _runTestsForDescribeBlock (.../jest-circus/build/run.js:126:9)
    at _runTestsForDescribeBlock (.../jest-circus/build/run.js:121:9)
    at run (.../jest-circus/build/run.js:71:3)
    at runAndTransformResultsToJestFormat (.../build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)
    at jestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:19)
    at runTestInternal (.../jest-runner/build/runTest.js:367:16)
    at runTest (.../jest-runner/build/runTest.js:444:34)
    at Object.worker (.../jest-runner/build/testWorker.js:106:12)

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

…or-new-sdk

szokeasaurusrex

Please see my inline comment.

Also, our Docs page says continuous profiling is still in Beta. Is this accurate? If yes, maybe we should wait until this is out of beta to merge this change; otherwise, let's remove the Beta notice from the Docs page.

static/app/gettingStartedDocs/python/aiohttp.tsx

instead of start_profile_session and stop_profile_session

…or-new-sdk

Zylphrex requested a review from a team as a code owner February 20, 2025 18:39

Zylphrex requested a review from a team February 20, 2025 18:39

github-actions bot added the Scope: Frontend Automatically applied to PRs that change frontend components label Feb 20, 2025

vercel bot deployed to Preview February 20, 2025 18:42 View deployment

JonasBa and others added 2 commits March 17, 2025 10:02

chore(profiling): Update python profiling docs for new SDK (#87015)

19ef6d5

Rename to profile_session_sample_rate introduced in https://github.com/getsentry/sentry-python/pull/4002/files

Merge branch 'master' into txiao/chore/update-python-profiling-docs-f…

6acb92a

…or-new-sdk

vercel bot deployed to Preview March 17, 2025 14:12 View deployment

Merge branch 'master' into txiao/chore/update-python-profiling-docs-f…

2559bb5

…or-new-sdk

vercel bot deployed to Preview March 17, 2025 14:20 View deployment

sentrivana approved these changes Mar 17, 2025

View reviewed changes

szokeasaurusrex reviewed Mar 17, 2025

View reviewed changes

static/app/gettingStartedDocs/python/aiohttp.tsx Outdated Show resolved Hide resolved

update getting started doc to use start_profiler and stop_profiler

7321c94

instead of start_profile_session and stop_profile_session

vercel bot deployed to Preview March 19, 2025 13:37 View deployment

Zylphrex added 4 commits March 28, 2025 17:24

Merge branch 'master' into txiao/chore/update-python-profiling-docs-f…

c1a13f9

…or-new-sdk

fix docs for continuous profiler

b82fcfb

undo unintentional change

1ea779c

undo unintentional change

c3910f4

vercel bot deployed to Preview March 28, 2025 21:37 View deployment

Zylphrex closed this Mar 31, 2025

Zylphrex deleted the txiao/chore/update-python-profiling-docs-for-new-sdk branch March 31, 2025 15:21

github-actions bot locked and limited conversation to collaborators Apr 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

chore(profiling): Update python profiling docs for new SDK #85560

chore(profiling): Update python profiling docs for new SDK #85560

Uh oh!

Zylphrex commented Feb 20, 2025 •

edited by viglia

Loading

Uh oh!

Zylphrex commented Feb 20, 2025

Uh oh!

codecov bot commented Mar 17, 2025 •

edited

Loading

Uh oh!

szokeasaurusrex left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chore(profiling): Update python profiling docs for new SDK #85560

chore(profiling): Update python profiling docs for new SDK #85560

Uh oh!

Conversation

Zylphrex commented Feb 20, 2025 • edited by viglia Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Zylphrex commented Feb 20, 2025

Uh oh!

codecov bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ 28 Tests Failed:

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Zylphrex commented Feb 20, 2025 •

edited by viglia

Loading

codecov bot commented Mar 17, 2025 •

edited

Loading