Skip to content

Commit 70233a5

Browse files
authored
added verify (#10949)
1 parent c3d5a37 commit 70233a5

File tree

18 files changed

+112
-28
lines changed

18 files changed

+112
-28
lines changed

docs/platforms/dotnet/guides/aspnet/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,12 @@ Opt-in to send the request body to Sentry:
113113
options.AddAspNet(RequestSize.Always);
114114
```
115115

116+
## Verify
117+
118+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
119+
120+
<PlatformContent includePath="getting-started-verify" />
121+
116122
## Troubleshooting
117123

118124
For information about Troubleshooting, please visit the [troubleshooting](troubleshooting) page.

docs/platforms/dotnet/guides/aspnetcore/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ Finally, any settings that can be configured via `appsettings.json` or environme
134134

135135
> Example modifying all events before they are sent to avoid server names being reported.
136136
137+
## Verify
138+
139+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
140+
141+
<PlatformContent includePath="getting-started-verify" />
142+
137143
## Dependency Injection
138144

139145
Much of the behavior of the ASP.NET Core integration with Sentry can be customized by using the frameworks dependency injection system. That is done by registering your own implementation of some of the exposed abstraction.

docs/platforms/dotnet/guides/aws-lambda/index.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ dotnet add package Sentry.AspNetCore -v {{@inject packages.version('sentry.dotne
2828

2929
You can combine this integration with a logging library like `log4net`, `NLog`, or `Serilog` to include both request data as well as your logs as breadcrumbs. The logging ingrations also capture events when an error is logged.
3030

31-
### Configure
31+
## Configure
3232

3333
All `ASP.NET Core` configurations are valid here. But one configuration in particular is relevant.
3434

@@ -62,6 +62,12 @@ public class LambdaEntryPoint : Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFu
6262

6363
Check out the [Sentry ASP.NET Core](/platforms/dotnet/guides/aspnetcore/) documentation for the complete set of options.
6464

65+
## Verify
66+
67+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
68+
69+
<PlatformContent includePath="getting-started-verify" />
70+
6571
## Samples
6672

6773
- Our [samples on GitHub](https://github.com/getsentry/sentry-dotnet/tree/main/samples/Sentry.Samples.Aws.Lambda.AspNetCoreServer) demonstrate Sentry on AWS Lambda. (**C#**)

docs/platforms/dotnet/guides/azure-functions-worker/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ var host = new HostBuilder()
6161
await host.RunAsync();
6262
```
6363

64+
## Verify
65+
66+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
67+
68+
<PlatformContent includePath="getting-started-verify" />
69+
6470
## Samples
6571

6672
- [Integration with Azure Functions](https://github.com/getsentry/sentry-dotnet/tree/main/src/Sentry.Azure.Functions.Worker) sample demonstrates Sentry with Azure Functions Isolated Worker SDK. (**C#**)

docs/platforms/dotnet/guides/blazor-webassembly/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ builder.Logging.AddSentry(o => o.InitializeSdk = false);
5252
await builder.Build().RunAsync();
5353
```
5454

55+
## Verify
56+
57+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
58+
59+
<PlatformContent includePath="getting-started-verify" />
60+
5561
## Samples
5662

5763
- This [integration with Blazor WebAssembly](https://github.com/getsentry/sentry-dotnet/tree/main/samples/Sentry.Samples.AspNetCore.Blazor.Wasm) sample demonstrates using Sentry with Blazor WebAssembly. (**C#**)

docs/platforms/dotnet/guides/entityframework/index.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,13 @@ public class MvcApplication : System.Web.HttpApplication
9090
}
9191
```
9292

93-
### Sample
93+
## Verify
94+
95+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
96+
97+
<PlatformContent includePath="getting-started-verify" />
98+
99+
## Sample
94100

95101
Check out a complete working [sample](https://github.com/getsentry/sentry-dotnet-ef/tree/master/samples/Sentry.Samples.AspNet.Mvc) to see it in action.
96102

docs/platforms/dotnet/guides/extensions-logging/index.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,13 @@ For example, to remove all tags starting with `PROC_`, add a tag filter to your
163163
options.TagFilters.Add("PROC_");
164164
```
165165

166-
### Samples
166+
## Verify
167+
168+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
169+
170+
<PlatformContent includePath="getting-started-verify" />
171+
172+
## Samples
167173

168174
- A [simple example](https://github.com/getsentry/sentry-dotnet/tree/main/samples/Sentry.Samples.ME.Logging) using simply the `LoggerFactory`.
169175
- An [example](https://github.com/getsentry/sentry-dotnet/tree/main/samples/Sentry.Samples.GenericHost) using the _generic host_.

docs/platforms/dotnet/guides/google-cloud-functions/index.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,17 @@ public class UserFactoryStartup : FunctionsStartup
153153
}
154154
```
155155

156-
## Options & Initialization
156+
### Options & Initialization
157157

158158
As previously mentioned, this package is a wrapper around [Sentry.Extensions.Logging](/platforms/dotnet/guides/extensions-logging/), [Sentry.AspNetCore](/platforms/dotnet/guides/aspnetcore/) and [Sentry](/platforms/dotnet/). Please refer to the documentation of these packages to get the options that are defined at those levels.
159159

160-
### Samples
160+
## Verify
161+
162+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
163+
164+
<PlatformContent includePath="getting-started-verify" />
165+
166+
## Samples
161167

162168
- [Google Cloud Functions sample](https://github.com/getsentry/sentry-dotnet/tree/main/samples/Sentry.Samples.Google.Cloud.Functions)
163169
- For [more samples](https://github.com/getsentry/sentry-dotnet-samples) of the .NET SDKs.

docs/platforms/dotnet/guides/log4net/index.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,13 @@ Also in the example above, you can find the DSN being set. That will instruct th
5555
This is only one of the ways to initialize the SDK. If you wish to configure the SDK programatically, you could **leave the DSN out** from the appender configuration section. The SDK needs to be initialized only **once** and since other integrations (like ASP.NET) are also able to initialize the SDK, you only need to pass the DSN to one of these integrations.
5656
One common case to not add the DSN to the XML configuration file (which would initialize it via the log4net integration) is to have full access to the [SDK option](/platforms/dotnet/guides/log4net/configuration/options/).
5757

58-
### Sample
58+
## Verify
59+
60+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
61+
62+
<PlatformContent includePath="getting-started-verify" />
63+
64+
## Sample
5965

6066
For a [sample app.config](https://github.com/getsentry/sentry-dotnet/blob/main/samples/Sentry.Samples.Log4Net/app.config) or a complete working [sample](https://github.com/getsentry/sentry-dotnet/tree/main/samples/Sentry.Samples.Log4Net) to see it in action.
6167

docs/platforms/dotnet/guides/maui/index.mdx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Install-Package Sentry.Maui -Version {{@inject packages.version('sentry.dotnet.m
4040

4141
This package extends [Sentry.Extensions.Logging](/platforms/dotnet/guides/extensions-logging/). This means that besides the MAUI related features, through this package you'll also get access to all the framework's logging integration and also the features available in the main [Sentry](/platforms/dotnet/) SDK.
4242

43-
### Configure
43+
## Configure
4444

4545
In your `MauiProgram.cs` file, call `UseSentry` on your `MauiAppBuilder`, and include any options you would like to set. The `Dsn` is the only required parameter.
4646

@@ -78,13 +78,13 @@ public static MauiApp CreateMauiApp()
7878
}
7979
```
8080

81-
## Options
81+
### Options
8282

8383
As previously mentioned, this package is a wrapper around [Sentry.Extensions.Logging](/platforms/dotnet/guides/extensions-logging/) and [Sentry](/platforms/dotnet/). Please refer to the documentation of these packages to get the options that are defined at those levels.
8484

8585
Below, the options that are specific to `Sentry.Maui` will be described.
8686

87-
### IncludeTextInBreadcrumbs
87+
#### IncludeTextInBreadcrumbs
8888

8989
This option controls whether elements that implement the `IText` interface (such as `Button`, `Label`, `Entry`, and others) will have their text included on breadcrumbs. This option is disabled by default.
9090

@@ -94,7 +94,7 @@ Use caution when enabling, as such values may contain personally identifiable in
9494

9595
</Alert>
9696

97-
### IncludeTitleInBreadcrumbs
97+
#### IncludeTitleInBreadcrumbs
9898

9999
This option contols whether elements that implement the `ITitledElement` interface (such as `Window`, `Page`, and others) will have their titles included on breadcrumbs. This option is disabled by default.
100100

@@ -104,7 +104,7 @@ Use caution when enabling, as such values may contain personally identifiable in
104104

105105
</Alert>
106106

107-
### IncludeBackgroundingStateInBreadcrumbs
107+
#### IncludeBackgroundingStateInBreadcrumbs
108108

109109
Controls whether the breadcrumb sent for the `Window.Backgrounding` event will include state data from `BackgroundingEventArgs.State`. This option is disabled by default.
110110

@@ -113,3 +113,9 @@ Controls whether the breadcrumb sent for the `Window.Backgrounding` event will i
113113
Use caution when enabling, as such values may contain personally identifiable information (PII).
114114

115115
</Alert>
116+
117+
## Verify
118+
119+
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
120+
121+
<PlatformContent includePath="getting-started-verify" />

0 commit comments

Comments
 (0)