Skip to content

Updated dotnet options to include all defaults #15218

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Oct 23, 2025
+10 −20
Merged

Updated dotnet options to include all defaults #15218

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f5690e6
Updated dotnet options to include all defaults
Oct 14, 2025
4689ca8
changing the shutdowntimeout langauge
Oct 14, 2025
9b6cda5
Update docs/platforms/dotnet/common/configuration/options.mdx
sfanahata Oct 22, 2025
19f9c17
Removed 'ScreenshotQuality'
bitsandfoxes Oct 23, 2025
974925d
Merge branch 'master' into dotnet-options-updates
bitsandfoxes Oct 23, 2025
0dbcd72
Capitalize Enhanced for StackTraceMode
alexsohn1126 Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 10 additions & 20 deletions docs/platforms/dotnet/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-uti

</SdkOption>

<SdkOption name="StackTraceMode" type="enum">
<SdkOption name="StackTraceMode" type="enum" defaultValue="Enhanced">

- Original - Default .NET stack trace format.
- Enhanced - Include `async`, return type, arguments, and more.
- Enhanced - **default** Include `async`, return type, arguments, and more.

Before version 3.0.0 of the Sentry SDK for .NET, there was no special treatment for the stack trace. Sentry reported what .NET made available at runtime.
This behavior now called `StackTraceMode.Original`. With the introduction of 3.0, a new default mode is `Enhanced`.
Expand Down Expand Up @@ -87,7 +87,7 @@ Turns debug mode on or off. If debug is enabled SDK will attempt to print out us

</SdkOption>

<SdkOption name="DiagnosticLevel" type="enum">
<SdkOption name="DiagnosticLevel" type="enum" defaultValue="debug">

Enabling `debug` mode makes the SDK generate as much diagnostic data as possible. However, if you'd prefer to lower the verbosity of the Sentry SDK diagnostics logs, configure this option to set the appropriate level:

Expand Down Expand Up @@ -143,7 +143,7 @@ The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/enve

</SdkOption>

<SdkOption name="AttachStacktrace" type="bool">
<SdkOption name="AttachStacktrace" type="bool" defaultValue="true">

When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.

Expand Down Expand Up @@ -193,11 +193,11 @@ This option can be overridden using <PlatformIdentifier name="InAppInclude" />.

<PlatformSection supported={["dotnet.aspnet", "dotnet.aspnetcore"]}>

<SdkOption name="MaxRequestBodySize" type="enum">
<SdkOption name="MaxRequestBodySize" type="enum" defaultValue="none">

This parameter controls whether integrations should capture HTTP request bodies. It can be set to one of the following values:

- `none`: Request bodies are never sent.
- `none`: **default** Request bodies are never sent.
- `small`: Only small request bodies will be captured. The cutoff for small depends on the SDK (typically 4KB).
- `medium`: Medium and small requests will be captured (typically 10KB).
- `always`: The SDK will always capture the request body as long as Sentry can make sense of it.
Expand All @@ -208,7 +208,7 @@ This parameter controls whether integrations should capture HTTP request bodies.

<PlatformSection supported={["dotnet.xamarin", "dotnet.maui"]}>

<SdkOption name="AttachScreenshot" type="bool">
<SdkOption name="AttachScreenshot" type="bool" defaultValue="false">

Takes a screenshot of the application when an error happens and includes it as an attachment.
Learn more about enriching events with screenshots in our <PlatformLink to="/enriching-events/screenshots/">Screenshots documentation</PlatformLink>.
Expand All @@ -217,23 +217,13 @@ Learn more about enriching events with screenshots in our <PlatformLink to="/enr

</PlatformSection>

<PlatformSection supported={["dotnet.xamarin"]}>

<SdkOption name="ScreenshotQuality" type="enum">

The quality of the attached screenshot. It can be set to `full`, `high`, `medium` or `low`.

</SdkOption>

</PlatformSection>

<SdkOption name="SendClientReports" type="bool">
<SdkOption name="SendClientReports" type="bool" defaultValue="true">

Set this boolean to `false` to disable sending of client reports. Client reports are a protocol feature that let clients send status reports about themselves to Sentry. They are currently mainly used to emit outcomes for events that were never sent.

</SdkOption>

<SdkOption name="CaptureFailedRequests" type="bool">
<SdkOption name="CaptureFailedRequests" type="bool" defaultValue="true">

Once enabled, this feature automatically captures HTTP client errors, like bad response codes, as error events and reports them to Sentry.

Expand Down Expand Up @@ -336,7 +326,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events

## Tracing Options

<SdkOption name="TracesSampleRate" type="float">
<SdkOption name="TracesSampleRate" type="float" defaultValue="0.0">

A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="TracesSampler" /> must be defined to enable tracing.

Expand Down
Loading