docs(profiling): add new cont profiling page docs #11376
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 240 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
JonasBa
force-pushed
the
jb/profiling/cont-profiling
branch
from
b7597aa
to
89acac7
Compare
lizokm
approved these changes
Sep 19, 2024
docs/product/explore/profiling/transaction-vs-continuous-profiling.mdx
Outdated
Show resolved
Hide resolved
docs/product/explore/profiling/transaction-vs-continuous-profiling.mdx
Outdated
Show resolved
Hide resolved
docs/product/explore/profiling/transaction-vs-continuous-profiling.mdx
Outdated
Show resolved
Hide resolved
docs/product/explore/profiling/transaction-vs-continuous-profiling.mdx
Outdated
Show resolved
Hide resolved
docs/product/explore/profiling/transaction-vs-continuous-profiling.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| It is advisable that you call the startProfiling method right after the Sentry SDK is initialized so that you gain visibility at the earliest point in your application lifecycle. From then on, the profiler will keep collecting profiles and sending chunks to Sentry until stopProfiling is called. | ||
|
|
||
| ## Enabling transaction or continuous profiling mode |
There was a problem hiding this comment.
Suggested change
| ## Enabling transaction or continuous profiling mode | |
| ## Choosing Between Transaction and Continuous Profiling Mode |
docs/product/explore/profiling/transaction-vs-continuous-profiling.mdx
Outdated
Show resolved
Hide resolved
Comment on lines
+51
to
+54
| If you wish to keep using transaction based profiling, then the options remain the same and you should either set profilesSampleRate or profilesSampler option on the SDK. | ||
|
|
||
|
|
||
| Example of enabling transaction based profiling in NodeJS |
There was a problem hiding this comment.
Suggested change
| If you wish to keep using transaction based profiling, then the options remain the same and you should either set profilesSampleRate or profilesSampler option on the SDK. | |
| Example of enabling transaction based profiling in NodeJS | |
| If you want to keep using transaction-based profiling, then the options are the same. You can set either the `profilesSampleRate` or the `profilesSampler` option on the SDK. | |
| Here's an example of enabling transaction-based profiling in NodeJS: |
| transaction.finish(); | ||
| ``` | ||
|
|
||
| Note that while the profiling mode cannot be changed at runtime, it is fine for different projects or applications to use different profiling modes, or to switch modes. |
There was a problem hiding this comment.
Suggested change
| Note that while the profiling mode cannot be changed at runtime, it is fine for different projects or applications to use different profiling modes, or to switch modes. | |
| Note, that while the profiling mode can't be changed at runtime, it's fine for different projects or applications to use different profiling modes, or to switch modes. |
Comment on lines
+69
to
+74
|
|
||
| ## Differences in product experience | ||
|
|
||
| The major difference in product experience when using continuous profiling is that you will be able to visualize a flamegraph for your entire application, which means you can now take a step back from the previous transaction based view and look at your application's runtime as a whole. This makes it easier to for you to prioritize the functions that are slowing down your entire application and not just one particular transaction. | ||
|
|
||
| The product experience otherwise remains largely the same with entrypoints into profiling being supported from various parts of the performance product. |
There was a problem hiding this comment.
Suggested change
| ## Differences in product experience | |
| The major difference in product experience when using continuous profiling is that you will be able to visualize a flamegraph for your entire application, which means you can now take a step back from the previous transaction based view and look at your application's runtime as a whole. This makes it easier to for you to prioritize the functions that are slowing down your entire application and not just one particular transaction. | |
| The product experience otherwise remains largely the same with entrypoints into profiling being supported from various parts of the performance product. | |
| ## Differences When Using Sentry | |
| The major difference between continuous profiling and transaction-based profiling when using Sentry, is that with continuous profiling you'll be able to visualize a flamegraph for your entire application. This means, that you'll be able to take a step back from the previous transaction-based view and look at your application's runtime as a whole, which makes it easier to prioritize the functions that are slowing down your entire application and not just one particular transaction. | |
| Otherwise, what you'll see in Sentry will be mostly the same. Entry points into profiling will continue to be supported by various parts of the performance product. |
…ling.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>
…ling.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>
…ling.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>
…ling.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>
…ling.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>
…ling.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>
…ling.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
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:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES