PushScope examples for .NET

[rodolfoBee]

Core or SDK?

Platform/SDK

Which part? Which one?

.NET SDK

Description

The page https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/enriching-events/scopes/ mentions:

We also support pushing and configuring a scope within a single call. This is typically called with-scope, push-scope or implemented as a function parameter on the capture methods, depending on the SDK. It's very helpful if you only want to send data for one specific event.

Without giving any example of how to implement with/push scope functions.

Suggested Solution

Give an example of push/with scope implementation

[getsentry-release]

Routing to @getsentry/team-mobile for triage. ⏲️

[mattjohnsonpint]

You're right - we're missing docs for this. It's there though. Use either SentrySdk.PushScope, or you can call any of the Capture methods such as SentrySdk.CaptureException and there's an overload that takes a scope (which is functionally similar to WithScope).

These need to be documented.

[mattjohnsonpint]

PushScope is used like this:

using (SentrySdk.PushScope())
{
    // Anything done within the using block is part of that scope.
    // For example, adding a breadcrumb to the scope:
    SentrySdk.AddBreadcrumb(
        message: $"Opened scenario {scenarioId}",
        category: "User Interaction",
        level: BreadcrumbLevel.Info);
}

There's another more advanced example in a sample app in the repo here.

[rodolfoBee]

In addition, please document WithScope that is also defined in the SDK: https://github.com/getsentry/sentry-dotnet/blob/main/src/Sentry/ISentryScopeManager.cs