Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How do I validate that enable tracing? #10503

Open
smeubank opened this issue Jun 26, 2024 · 3 comments · May be fixed by #10505
Open

How do I validate that enable tracing? #10503

smeubank opened this issue Jun 26, 2024 · 3 comments · May be fixed by #10505
Labels
Product Area: SDKs - Web Frontend Type: Content Issues about the contents of our docs

Comments

@smeubank
Copy link
Member

Core or SDK?

Platform/SDK

Which part? Which one?

All but let's start with react based Next.js

Description

Our docs, at least for setting up errors, have followed a simple format at their core: 1. install 2. configure 3. validate

This is establishes a pretty straigh forward path to set it up, users generally know what errors, are and an example to get you going using Sentry. For tracing we do not follow such a pattern exactly.

Starting from the Next.js/Set Up Tracing docs, i first presented with a pagraph on "tracing . . . performance . . . measuring metrics . . . displaying impact of errors across multiple systems"

What? That is so far ahead of where the developer is at this stage, and even is some pretty broad strokes claims I am not sure of. So what exactly should I expect when I turn this on? What will a "trace" be in Sentry for my Next.js application?

Suggested Solution

  1. remove|replace both of those notes which appear before configure
  2. move distributed tracing upsell lower
  3. add bullet points > this is SOME of what you should see that will create traces automatically for Next.js
    • Page loads and navigations
    • Functions
      • Server Components (Layout and Page)
      • Page.generateMetadata (i think this is too specific)
    • Middleware

image

@smeubank smeubank added Type: Content Issues about the contents of our docs Product Area: SDKs - Web Frontend labels Jun 26, 2024
@getsantry
Copy link
Contributor

getsantry bot commented Jun 26, 2024

Routing to @getsentry/product-owners-sdks-web-frontend for triage ⏲️

@smeubank smeubank linked a pull request Jun 26, 2024 that will close this issue
@stephanie-anderson
Copy link
Contributor

I fully agree, thanks for taking the time to improve this! What I was thinking was, to also remove the traces_sampler instructions from this page, and reference it as advanced use case. This would further simplify the instructions

@smeubank
Copy link
Member Author

to also remove the traces_sampler instructions from this page, and reference it as advanced use case.

i agree, i want to think for the other PR to change it to tell the user to verify not based on sampling at all, but to go check for their page loads etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Product Area: SDKs - Web Frontend Type: Content Issues about the contents of our docs
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

2 participants