Fix SDK getting started pages (onboarding options) (#12960)

* fix(elixir): code block formatting * fix(.net): onboarding options * fix(php): onboarding options * fix(js): angular onboarding options * fix(js): astro onboarding options * fix(js): aws lambda onboarding options * fix(js): azure functions onboarding options * fix(js): bun onboarding options * fix(js): capacitor onboarding options * fix(js): cloudflare onboarding options * fix(js): connect onboarding options * fix(js): cordova onboarding options * fix(js): deno onboarding options * fix(js): electron onboarding options * fix(js): ember onboarding options * fix(js): deno code snippet for npm * fix(js): express onboarding options * fix(js): fastify onboarding options * fix(js): gatsby onboarding options * fix(js): gcp functions onboarding options * fix(js): hapi onboarding options * fix(js): hono onboarding options * fix(js): koa onboarding options * fix(js): nest.js onboarding options * fix(js): next.js onboarding options * fix(js): nuxt onboarding options * fix(js): react onboarding options * fix(js): react-router onboarding options * fix(js): remix onboarding options * fix(js): solid onboarding options * fix(js): solidstart onboarding options * fix(js): svelte onboarding options * fix(js): sveltekit onboarding options * fix(js): vue onboarding options * fix(js): wasm onboarding options
getsentry · Mar 7, 2025 · 10e4a72 · 10e4a72
1 parent 074644f
commit 10e4a72
Show file tree

Hide file tree

Showing 152 changed files with 2,432 additions and 1,860 deletions.
diff --git a/docs/platforms/dotnet/guides/aspnet/index.mdx b/docs/platforms/dotnet/guides/aspnet/index.mdx
@@ -34,7 +34,7 @@ as well as your logs as breadcrumbs. The logging integrations also capture event
 You configure the SDK in the `Global.asax.cs`:
 
 
-```csharp {"onboardingOptions": {"performance": "21-24, 34-43"}}
+```csharp {"onboardingOptions": {"performance": "20-23, 33-42"}}
 using System;
 using System.Web;
 using Sentry.AspNet;

diff --git a/docs/platforms/dotnet/guides/aws-lambda/index.mdx b/docs/platforms/dotnet/guides/aws-lambda/index.mdx
@@ -35,7 +35,7 @@ All `ASP.NET Core` configurations are valid here. But one configuration in parti
 `FlushOnCompletedRequest` ensures all events are flushed out. This is because the general ASP.NET Core hooks for when the process is exiting are not guaranteed to run in a serverless environment. This setting ensures that no event is lost if AWS recycles the process.
 
 
-```csharp {"onboardingOptions": {"performance": "12-14"}}
+```csharp {"onboardingOptions": {"performance": "12-15"}}
 public class LambdaEntryPoint : Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction
 {
     protected override void Init(IWebHostBuilder builder)

diff --git a/docs/platforms/dotnet/guides/azure-functions-worker/index.mdx b/docs/platforms/dotnet/guides/azure-functions-worker/index.mdx
@@ -33,7 +33,7 @@ This package extends [Sentry.Extensions.Logging](/platforms/dotnet/guides/extens
 
 Sentry integration with Azure Functions is done by calling `.UseSentry()` and specifying the options, for example:
 
-```csharp {"onboardingOptions": {"performance": "11-13"}}
+```csharp {"onboardingOptions": {"performance": "10-12"}}
 using Sentry.Azure.Functions.Worker;
 
 var builder = FunctionsApplication.CreateBuilder(args);
@@ -57,7 +57,7 @@ If using the ASP.NET Core integration add `UseSentry` to the `ConfigureFunctions
 
 </Alert>
 
-```csharp 
+```csharp {"onboardingOptions": {"performance": "11-13"}}
 using Sentry.Azure.Functions.Worker;
 
 var host = new HostBuilder()

diff --git a/docs/platforms/dotnet/guides/blazor-webassembly/index.mdx b/docs/platforms/dotnet/guides/blazor-webassembly/index.mdx
@@ -8,6 +8,8 @@ Sentry provides an integration with Blazor WebAssembly through the [Sentry.AspNe
 
 ## Install
 
+<OnboardingOptionButtons options={['error-monitoring', 'performance']}/>
+
 Add the Sentry dependency to your Blazor WebAssembly application:
 
 ```shell {tabTitle:.NET Core CLI}
@@ -26,16 +28,14 @@ Sentry integration with Blazor WebAssembly is done by calling `.UseSentry()` and
 
 
 
-```csharp
+```csharp {"onboardingOptions": {"performance": "5"}}
 var builder = WebAssemblyHostBuilder.CreateDefault(args);
 builder.UseSentry(options =>
 {
-        options.Dsn = "___PUBLIC_DSN___";
-        options.TracesSampleRate = 0.1;
-        // When configuring for the first time, to see what the SDK is doing:
-        // options.Debug = true;
-
-
+    options.Dsn = "___PUBLIC_DSN___";
+    options.TracesSampleRate = 0.1;
+    // When configuring for the first time, to see what the SDK is doing:
+    // options.Debug = true;
 });
 
 // Captures logError and higher as events

diff --git a/docs/platforms/dotnet/guides/entityframework/index.mdx b/docs/platforms/dotnet/guides/entityframework/index.mdx
@@ -45,7 +45,7 @@ Add the Entity Framework 6 support to your project in one step:
 
 For example, configuring an ASP.NET app with _global.asax_:
 
-```csharp {filename:global.asax} {"onboardingOptions": {"performance": "16-18, 27-36"}}
+```csharp {filename:global.asax} {"onboardingOptions": {"performance": "15-17, 26-35"}}
 using System;
 using System.Configuration;
 using Sentry.AspNet;

diff --git a/docs/platforms/dotnet/guides/uwp/index.mdx b/docs/platforms/dotnet/guides/uwp/index.mdx
@@ -28,7 +28,7 @@ The SDK should be initialized in the constructor of your application class (usua
 </Alert>
 
 
-```csharp {"onboardingOptions": {"performance": "18-21"}}
+```csharp {"onboardingOptions": {"performance": "17-20"}}
 using Sentry.Protocol;
 using UnhandledExceptionEventArgs = Windows.UI.Xaml.UnhandledExceptionEventArgs;
 

diff --git a/docs/platforms/dotnet/guides/winforms/index.mdx b/docs/platforms/dotnet/guides/winforms/index.mdx
@@ -30,7 +30,7 @@ You should also set `Application.SetUnhandledExceptionMode(UnhandledExceptionMod
 A complete example of the recommended startup is as follows:
 
 
-```csharp {"onboardingOptions": {"performance": "32-35"}}
+```csharp {"onboardingOptions": {"performance": "31-34"}}
 using System;
 using System.Windows.Forms;
 

diff --git a/docs/platforms/dotnet/guides/winui/index.mdx b/docs/platforms/dotnet/guides/winui/index.mdx
@@ -32,9 +32,7 @@ In addition to capturing errors, you can monitor interactions between multiple s
 
 Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.
 
-<OnboardingOptionButtons options={['error-monitoring', 'performance']}/>
-
-```csharp {"onboardingOptions": {"performance": "17-20"}}
+```csharp {"onboardingOptions": {"performance": "16-19"}}
 using Sentry.Protocol;
 
 sealed partial class App : Application
@@ -50,7 +48,7 @@ sealed partial class App : Application
             // When configuring for the first time, to see what the SDK is doing:
             options.Debug = true;
 
-            // Set traces_sample_rate to 1.0 to capture 100% of transactions for tracing.
+            // Set TracesSampleRate to 1.0 to capture 100% of transactions for tracing.
             // We recommend adjusting this value in production.
             options.TracesSampleRate = 1.0;
 
@@ -79,7 +77,7 @@ Do not initialize the SDK in the `OnLaunched` event of the application or the `H
 </Alert>
 
 
-```csharp
+```csharp {"onboardingOptions": {"performance": "18-21"}}
 // Add these to your existing using statements.
 using Sentry.Protocol;
 using UnhandledExceptionEventArgs = Microsoft.UI.Xaml.UnhandledExceptionEventArgs;
@@ -97,7 +95,7 @@ sealed partial class App : Application
             // When configuring for the first time, to see what the SDK is doing:
             o.Debug = true;
 
-            // Set traces_sample_rate to 1.0 to capture 100% of transactions for tracing.
+            // Set TracesSampleRate to 1.0 to capture 100% of transactions for tracing.
             // We recommend adjusting this value in production.
             o.TracesSampleRate = 1.0;
 

diff --git a/docs/platforms/dotnet/guides/xamarin/index.mdx b/docs/platforms/dotnet/guides/xamarin/index.mdx
@@ -21,7 +21,27 @@ The SDK is compatible with the following versions or higher:
 
 After you’ve completed setting up a project in Sentry, Sentry will give you a value which we call a DSN or Data Source Name. It looks a lot like a standard URL, but it’s just a representation of the configuration required by the Sentry SDKs. It consists of a few pieces, including the protocol, public key, the server address, and the project identifier.
 
-<PlatformContent includePath="getting-started-config" />
+<OnboardingOptionButtons options={['error-monitoring', 'performance']}/>
+
+You should initialize the SDK as early as possible, for an example, the start of OnCreate
+on MainActivity for Android, and, the top of FinishedLaunching on AppDelegate for iOS).
+
+```csharp {"onboardingOptions": {"performance": "8-11"}}
+SentryXamarin.Init(options =>
+{
+    options.AddXamarinFormsIntegration();
+    // Tells which project in Sentry to send events to:
+    options.Dsn = "___PUBLIC_DSN___";
+    // When configuring for the first time, to see what the SDK is doing:
+    options.Debug = true;
+    // Set TracesSampleRate to 1.0 to capture 100%
+    // of transactions for tracing.
+    // We recommend adjusting this value in production
+    options.TracesSampleRate = 1.0;
+});
+// App code
+
+```
 
 ## Verify
 

diff --git a/docs/platforms/dotnet/index.mdx b/docs/platforms/dotnet/index.mdx
@@ -81,7 +81,7 @@ Install the **NuGet** package to add the Sentry dependency:
 To capture all errors, even the one during the startup of your application, you should initialize the Sentry .NET SDK as soon as possible.
 
 
-```csharp {"onboardingOptions": {"performance": "6-7", "profiling": "8-9"}}
+```csharp {"onboardingOptions": {"performance": "5-6", "profiling": "7-8"}}
 SentrySdk.Init(options =>
 {
     options.Dsn = "https://[email protected]/5428537";

diff --git a/docs/platforms/elixir/integrations/oban/index.mdx b/docs/platforms/elixir/integrations/oban/index.mdx
@@ -18,16 +18,16 @@ This integration is built into the Sentry SDK starting with *v10.2.0*. It suppor
 
 You can configure the Oban integration in your Sentry configuration, under the `:integrations` key:
 
-```elixir {filename:config/config.exs}
+```elixir {filename:config/config.exs} {diff}
 config :sentry,
   # ...,
   integrations: [
-    oban: [
-      # Capture errors:
-      capture_errors: true,
-      # Monitor cron jobs:
-      cron: [enabled: true]
-    ]
++    oban: [
++      # Capture errors:
++      capture_errors: true,
++      # Monitor cron jobs:
++      cron: [enabled: true]
++    ]
   ]
 ```
 
@@ -64,14 +64,14 @@ If you want to customize the information that is sent to Sentry when a job check
 ```elixir {filename:lib/my_app/my_worker.ex}
 defmodule MyApp.MyWorker do
   use Oban.Worker
-  
+
   @behaviour Sentry.Integrations.Oban.Cron
-  
+
   @impl Oban.Worker
   def perform(args) do
     # ...
   end
-  
+
   @impl Sentry.Integrations.Oban.Cron
   def sentry_check_in_configuration(job) do
     [monitor_slug: "custom-slug-#{job.id}"]

diff --git a/docs/platforms/elixir/integrations/plug_and_phoenix/index.mdx b/docs/platforms/elixir/integrations/plug_and_phoenix/index.mdx
@@ -15,8 +15,8 @@ If you are using Phoenix, follow these steps to add the Plug integration:
   1. Add `Sentry.PlugCapture` above the `use Phoenix.Endpoint` line in your endpoint file.
   1. Add `Sentry.PlugContext` below `Plug.Parsers`.
 
-```diff
- defmodule MyAppWeb.Endpoint
+```elixir {diff}
+defmodule MyAppWeb.Endpoint
 +  use Sentry.PlugCapture
    use Phoenix.Endpoint, otp_app: :my_app
 
@@ -81,7 +81,7 @@ If you have a non-Phoenix application, follow these steps to configure the Plug
   1. Add `Sentry.PlugCapture` at the top of your Plug application.
   1. Add `Sentry.PlugContext` below `Plug.Parsers` (if it is in your stack).
 
-```diff
+```elixir {diff}
  defmodule MyApp.Router do
    use Plug.Router
 +  use Sentry.PlugCapture

diff --git a/docs/platforms/elixir/integrations/quantum/index.mdx b/docs/platforms/elixir/integrations/quantum/index.mdx
@@ -12,13 +12,12 @@ This integration is built into the Sentry SDK.
 
 You can configure the Quantum integration in your Sentry configuration, under the `:integrations` key:
 
-```elixir {filename:config/config.exs)
-
+```elixir {filename:config/config.exs} {diff}
 config :sentry,
   # ...,
   integrations: [
-    quantum: [
-      cron: [enabled: true]
-    ]
++    quantum: [
++      cron: [enabled: true]
++    ]
   ]
 ```
diff --git a/docs/platforms/javascript/common/troubleshooting/index.mdx b/docs/platforms/javascript/common/troubleshooting/index.mdx
@@ -391,7 +391,7 @@ Error: Could not resolve './{}.js' from node_modules/@sentry/utils/esm/index.js
 
 This might be because the [`define`](https://vitejs.dev/config/shared-options.html#define) option in your Vite config is string-replacing some variable used by the Sentry SDK, like `global`, which causes build errors. Vite recommends using `define` for CONSTANTS only, and not putting `process` or `global` into the options. To fix this build error, remove or update your `define` option, as shown below:
 
-```diff {filename:vite.config.ts}
+```javascript {filename:vite.config.ts} {diff}
 export default defineConfig({
    build: {
      sourcemap: true

diff --git a/docs/platforms/javascript/guides/angular/config.yml b/docs/platforms/javascript/guides/angular/config.yml
diff --git a/...ng-started-install/javascript.angular.mdx → ...forms/javascript/guides/angular/index.mdx b/...ng-started-install/javascript.angular.mdx → ...forms/javascript/guides/angular/index.mdx
@@ -1,3 +1,28 @@
+---
+title: Angular
+description: 'Angular is a web framework that empowers developers to build fast, reliable applications. Learn how to set it up with Sentry.'
+sdk: sentry.javascript.angular
+categories:
+  - javascript
+  - browser
+---
+
+<PlatformContent includePath="getting-started-primer" />
+
+<PlatformContent includePath="getting-started-prerequisites" />
+
+## Features
+
+In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). You can also get to the root of an error or performance issue faster, by watching a video-like reproduction of a user session with [session replay](/product/explore/session-replay/web/getting-started/).
+
+Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.
+
+## Install
+
+<OnboardingOptionButtons options={["error-monitoring", "performance", "session-replay"]} />
+
+Sentry captures data by using an SDK within your application’s runtime.
+
 ```bash {tabTitle:npm}
 npm install @sentry/angular --save
 ```
@@ -31,3 +56,25 @@ If you're using an older version of Angular, you also need to use an older versi
 The `@sentry/angular-ivy` package was an Ivy-compatible version of `@sentry/angular` in version 7 of the SDK. It's recommended to use this package if you're using Angular 12 or 13 to avoid build-time warnings.
 Functionality-wise, it's identical to `@sentry/angular` and you can simply replace all imports of `@sentry/angular` with `@sentry/angular-ivy` in our docs.
 Since version 8, `@sentry/angular-ivy` was [removed and merged](./migration/v7-to-v8/#supported-versions) with `@sentry/angular` which is now Ivy-compatible by default.
+
+## Configure
+
+Configuration should happen as early as possible in your application's lifecycle.
+
+<PlatformContent includePath="getting-started-config" />
+
+<PlatformContent includePath="getting-started-sourcemaps" />
+
+## Verify
+
+This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
+
+<PlatformContent includePath="getting-started-verify" />
+
+<Alert>
+
+Learn more about manually capturing an error or message in our <PlatformLink to="/usage/">Usage documentation</PlatformLink>.
+
+</Alert>
+
+To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
diff --git a/docs/platforms/javascript/guides/astro/config.yml b/docs/platforms/javascript/guides/astro/config.yml