docs(python): Update Python main quick start guide#18365
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
inventarSarah
force-pushed
the
smi/quick-start/python
branch
from
2701cea to
67d6879
Compare
dingsdax
requested review from
alexander-alderman-webb,
ericapisani,
sentrivana and
sl0thentr0py
sentrivana
left a comment
sentrivana
left a comment
There was a problem hiding this comment.
This is a major glow up, thank you!
Looks good to me, but please have a look at the comments.
| <Alert level="warning" title="Continuous profiling vs transaction-based profiling"> | ||
|
|
||
| With the configuration above, you enable continuous profiling. However, the SDK also supports transaction-based profiling via the `profiles_sample_rate` option. These profiling mode options have similar names, so make sure you're using the right one for your chosen mode. | ||
| See <PlatformLink to="/profiling/">Profiling</PlatformLink> to learn more. | ||
|
|
||
| </Alert> |
There was a problem hiding this comment.
I'd leave this out altogether since we'll be deprecating transaction-based profiling and dropping it in the next major. So for folks setting up the SDK for the first time, which is the target audience here, I'd just recommend to set up continuous profiling.
On the profiling page, we should absolutely talk about the distinction and the confusing options (I believe we already do).
| <OnboardingOption optionId="performance"> | ||
| ### Instrumenting Your App | ||
|
|
||
| The Sentry SDK automatically detects your installed packages and enables matching integrations, so operations like HTTP requests or database queries made with supported libraries will be captured as spans automatically. |
There was a problem hiding this comment.
Most integrations will auto enable but there's still a handful that need to be enabled manually -- the current wording makes it sound like all are auto-enabling.
Maybe something like this? Or a bigger rewording would make sense here?
| The Sentry SDK automatically detects your installed packages and enables matching integrations, so operations like HTTP requests or database queries made with supported libraries will be captured as spans automatically. | |
| The Sentry SDK automatically detects your installed packages and enables matching integrations for the most popular frameworks and libraries, so operations like HTTP requests or database queries made with supported libraries will be captured as spans automatically. |
| sentry_sdk.logger.info('This is an info log message') | ||
| sentry_sdk.logger.warning('This is a warning message') | ||
| sentry_sdk.logger.error('This is an error message') |
There was a problem hiding this comment.
| sentry_sdk.logger.info('This is an info log message') | |
| sentry_sdk.logger.warning('This is a warning message') | |
| sentry_sdk.logger.error('This is an error message') | |
| sentry_sdk.logger.info("This is an info log message") | |
| sentry_sdk.logger.warning("This is a warning message") | |
| sentry_sdk.logger.error("This is an error message") |
No functional change; just to keep the quotes consistent on the page
3 participants
DESCRIBE YOUR PR
This branch contains the updated Python quick start guide.
Most important updates:
poetryinstall command (as seen in the guide in Sentry)Closes: #18364
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES