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

ASP.NET Core docs for performance don't mention requests are measured #8532

Open
bruno-garcia opened this issue Nov 19, 2023 · 6 comments
Open
Assignees
Labels
Platform: .NET Team: Web Backend SDKs team-web-sdk-backend Type: Content Issues about the contents of our docs

Comments

@bruno-garcia
Copy link
Member

bruno-garcia commented Nov 19, 2023

https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/performance/

Missing the UseSentryTracing instructions.

This way users will not get any transactions.
Must have regressed at some point

new project wizard in-product has the instructions:
image

With Sentry SDK for .NET version 4.0.0 we'll drop .NET 5 (6 will be the lowest) so worth updating that comment

@kanadaj
Copy link
Contributor

kanadaj commented Nov 19, 2023

Correction: UseSentryTracing

@jamescrosswell
Copy link
Collaborator

@bruno-garcia not regressed... updated to reflect this change in 3.40.0:

@bruno-garcia
Copy link
Member Author

Context about this change and side effects on Discord: https://discord.com/channels/621778831602221064/1175852280625500281/1175901670702600323

@jamescrosswell there's no reference of this at all on the docs: https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/performance/

We could expand on this, for users coming back after using the middleware and new users, that wonder what setting the sample rate does

@bruno-garcia bruno-garcia changed the title ASP.NET Dore docs for performance are broken ASP.NET Core docs for performance don't mention what setting sample rate results in Nov 19, 2023
@bruno-garcia
Copy link
Member Author

Verify in the docs tells ppl to go to the Custom Transaction:

Verify
Test out tracingThe process of logging the events that took place during a request, often across multiple services. by starting and finishing a transaction, which you must do so transactions can be sent to Sentry. Learn how in our Custom Instrumentation content.

While you're testing, set TracesSampleRate to 1.0, as that ensures that every transaction will be sent to Sentry.

Once testing is complete, you may want to set a lower TracesSampleRate value, or switch to using TracesSampler to selectively sample and filter your transactions, based on contextual data.

@bruno-garcia bruno-garcia changed the title ASP.NET Core docs for performance don't mention what setting sample rate results in ASP.NET Core docs for performance don't mention requests are measured Nov 19, 2023
@jamescrosswell
Copy link
Collaborator

https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/performance/

We could expand on this, for users coming back after using the middleware and new users, that wonder what setting the sample rate does

Do you mean like some docs saying that people no longer need to call UseSentryTracing? Maybe we add something after completing getsentry/sentry-dotnet#2865 (explaining in which circumstances they would/wouldn't need to call this themselves manually)?

@bruno-garcia
Copy link
Member Author

Do you mean like some docs saying that people no longer need to call UseSentryTracing? Maybe we add something after completing getsentry/sentry-dotnet#2865 (explaining in which circumstances they would/wouldn't need to call this themselves manually)?

Yeah we usually write stuff on a migration document (https://docs.sentry.io/platforms/dotnet/migration/)
A section on the aspnet core docs for performance clarifying how this works (calling out "From version XYZ you no longer need to call UseTracing because...") that's a good opportunity to explain how it works. Where we added it, and edge cases, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Platform: .NET Team: Web Backend SDKs team-web-sdk-backend Type: Content Issues about the contents of our docs
Projects
Status: Todo
Development

No branches or pull requests

5 participants