Suggested changes for putting rage click thresholds on more appropriate docs pages #10329
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will decrease total bundle size by 11 bytes ⬇️
|
docs/platforms/javascript/common/session-replay/understanding-sessions.mdx
Outdated
Show resolved
Hide resolved
| @@ -109,6 +109,16 @@ In `session` mode, this will upload any pending recording data to Sentry. In `bu | |||
|
|
|||
| Note that it's safe to call `flush()` at any time, even if Session Replay is stopped, in which case, it will do nothing. | |||
|
|
|||
| ## Dead Clicks and Rage Clicks | |||
There was a problem hiding this comment.
I think this might be better fit under the other page also edited, the Replay Issues one
There was a problem hiding this comment.
Yeah - I was thinking the same - only thing was that when I was actually searching for this information when I was testing an application I first went to look on the Session Replay docs - so I was trying to find a good place to put this somewhere that made sense on the Session Replay JS SDK docs page...I agree though in general. I couldn't find a good place for it. So happy to have it not show up here.
Reasoning:
I notice rage clicks when I'm looking at the Session Replay, so when I have a question about rage clicks my first inclination is to go to the Session Replay docs, where I couldn't find this information or a link to it.
There was a problem hiding this comment.
I was thinking on the index.md of the Session Replay JS SDK doc after this section:
https://docs.sentry.io/platforms/javascript/session-replay/#error-linking
There was a problem hiding this comment.
FWIW the original is from the Troubleshooting on the Session Replay JS SDK docs, so removing it completely from this section would seem strange?
There are so many entry points into Session Replay docs though, so I don't think I'm the person who would know the right place necessarily for this.
There was a problem hiding this comment.
If we put this as a new page that is a sibling to /product/session-replay/performance-overhead/
Then in the product space we'll have these in the navbar:
Issues
∟ Issue Details
∟ Rage Click Issues
Session Replay
∟ Dead & Rage Clicks <- the new page
"Rage Click Issues" that we already have, has subheadings: "Detection Criteria, Span Evidence, Fingerprinting" and the new page will have "Dead Clicks and Rage Clicks" only.
... then we have to cross link the pages which is fine, but it just feels like too many pages.
My thought is to put this content directly into docs/product/issues/issue-details/replay-issues/index.mdx.
That little tree structure is probably in the wrong spot to begin with, Issues > Issue Details -> X has a lot of stuff that could be better off inside something like "Issues > Issue Types > X. Like Issues > Issue Types > N+1 QueriesorIssues > Issue Types > Rage Clicks`.
But lets save that for the next PR
Co-authored-by: Michelle Zhang <[email protected]>
…sessions.mdx Co-authored-by: Michelle Zhang <[email protected]>
| ### Why am I seeing too many or too few rage clicks? | ||
| There might be fewer rage clicks than you expect if the user stopped waiting for the site to respond before the 7 second threshold and instead chose to to something else. This is why the rage click issues that you *do* see are so valuable, because the user that clicked at least 3 times and continued waiting at least 7 seconds for the site to respond is likely very frustrated. | ||
|
|
||
| You might also see more rage clicks than you expected from buttons that don't trigger a DOM mutation or page scroll, i.e. Print and Download buttons. There is no reliable way for the SDK to detect that a download or print has initiated, so a slow click might be generated even if the button is not actually "dead". For these cases, you can configure the SDK via `slowClickIgnoreSelectors` - see <PlatformLink to='/session-replay/configuration'>Configuration</PlatformLink> for more details. |
There was a problem hiding this comment.
This link to the configuration redirects to choose which platform you're using first - which looks like an error. Is there a good way to redirect specifically to JS?
There was a problem hiding this comment.
@vivianyentran maybe would know?
|
@ryan953 @bruno-garcia @michellewzhang Does this seem better for the initial move from the troubleshooting to the issues page? |
Co-authored-by: vivianyentran <[email protected]>
Co-authored-by: vivianyentran <[email protected]>
Co-authored-by: vivianyentran <[email protected]>
|
looks good to me. Thanks @drguthals for taking the time to address this |
|
Thanks Sarah! |
DESCRIBE YOUR PR
Fixes #10277
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
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