Skip to content

Commit b2c9e4c

Browse files
Improve onboarding options (#10390)
1 parent ddc0b40 commit b2c9e4c

File tree

10 files changed

+53
-54
lines changed

10 files changed

+53
-54
lines changed

docs/platforms/dotnet/config.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/platforms/dotnet/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: .NET
33
sdk: sentry.dotnet
4-
caseStyle: snake_case
4+
caseStyle: PascalCase
55
supportLevel: production
6+
aliases:
7+
- C#
68
---
79

810
On this page, we get you up and running with Sentry's .NET SDK, automatically reporting errors and exceptions in your application.

docs/platforms/javascript/guides/gcp-functions/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To set up Sentry for a Google Cloud Function:
2727

2828
<SignInNote />
2929

30-
```javascript {tabTitle:Http functions}
30+
```javascript {tabTitle:Http functions} {"onboardingOptions": {"performance": "5-9"}}
3131
const Sentry = require("@sentry/google-cloud-serverless");
3232

3333
Sentry.init({
@@ -44,7 +44,7 @@ exports.helloHttp = Sentry.wrapHttpFunction((req, res) => {
4444
});
4545
```
4646

47-
```javascript {tabTitle:Background functions}
47+
```javascript {tabTitle:Background functions} {"onboardingOptions": {"performance": "5"}}
4848
const Sentry = require("@sentry/google-cloud-serverless");
4949

5050
Sentry.init({
@@ -59,7 +59,7 @@ exports.helloEvents = Sentry.wrapEventFunction(
5959
);
6060
```
6161

62-
```javascript {tabTitle:CloudEvent functions}
62+
```javascript {tabTitle:CloudEvent functions} {"onboardingOptions": {"performance": "5"}}
6363
const Sentry = require("@sentry/google-cloud-serverless");
6464

6565
Sentry.init({

docs/platforms/javascript/guides/remix/manual-setup.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ description: "Learn how to set up the SDK manually."
66

77
If you can't (or prefer not to) run the [automatic setup](/platforms/javascript/guides/remix/#install), you can follow the instructions below to configure your application.
88

9-
## Installation
9+
## Install
10+
11+
<OnboardingOptionButtons
12+
options={["error-monitoring", "performance", "profiling", "session-replay"]}
13+
/>
1014

1115
Get started by installing the Sentry Remix SDK:
1216

@@ -22,7 +26,7 @@ yarn add @sentry/remix
2226
pnpm add @sentry/remix
2327
```
2428

25-
## Configuration
29+
## Configure
2630

2731
To use this SDK, initialize Sentry in your Remix entry points for both the client and server.
2832

@@ -34,7 +38,7 @@ The two configuration types are mostly the same, except that some configuration
3438

3539
### Client-side Configuration
3640

37-
```typescript {tabTitle:Client} {filename: entry.client.tsx}
41+
```typescript {tabTitle:Client} {filename: entry.client.tsx} {"onboardingOptions": {"performance": "8-12,16-23", "session-replay": "13-14,24-28"}}
3842
import { useLocation, useMatches } from "@remix-run/react";
3943
import * as Sentry from "@sentry/remix";
4044
import { useEffect } from "react";
@@ -68,7 +72,7 @@ Sentry.init({
6872

6973
### Server-side Configuration
7074

71-
```typescript {tabTitle:Server} {filename: entry.server.tsx}
75+
```typescript {tabTitle:Server} {filename: entry.server.tsx} {"onboardingOptions": {"performance": "5-9"}}
7276
import * as Sentry from "@sentry/remix";
7377

7478
Sentry.init({

docs/platforms/javascript/guides/sveltekit/manual-setup.mdx

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Learn how to set up the SDK manually."
66

77
If you can't (or prefer not to) run the <PlatformLink to="/#install">automatic setup</PlatformLink>, you can follow the instructions below to configure the Sentry SvelteKit SDK in your application. This guide is also useful to adjust the pre-set configuration if you used the installation wizard for automatic setup.
88

9-
## Installation
9+
## Install
1010

1111
```bash {tabTitle:npm}
1212
npm install --save @sentry/sveltekit
@@ -22,7 +22,9 @@ pnpm add @sentry/sveltekit
2222

2323
If you're updating your Sentry SDK to the latest version, check out our [migration guide](https://github.com/getsentry/sentry-javascript/blob/master/MIGRATION.md) to learn more about breaking changes.
2424

25-
## Client-side Setup
25+
## Configure
26+
27+
### Client-side Setup
2628

2729
1. If you don't already have a [client hooks](https://kit.svelte.dev/docs/hooks#shared-hooks) file, create a new one in `src/hooks.client.(js|ts)`.
2830

@@ -88,7 +90,7 @@ export const handleError = Sentry.handleErrorWithSentry(myErrorHandler);
8890
// export const handleError = handleErrorWithSentry();
8991
```
9092

91-
## Server-side Setup
93+
### Server-side Setup
9294

9395
1. If you don't already have a [server hooks](https://kit.svelte.dev/docs/hooks#server-hooks) file, create a new one in `src/hooks.server.(js|ts)`.
9496

@@ -157,7 +159,7 @@ export const handle = Sentry.sentryHandle();
157159
// export const handle = sequence(Sentry.sentryHandle(), yourHandler());
158160
```
159161

160-
## Vite Setup
162+
### Vite Setup
161163

162164
Add the `sentrySvelteKit` plugins to your `vite.config.(js|ts)` file so the Sentry SDK can apply build-time features.
163165
Make sure that it is added _before_ the sveltekit plugin:
@@ -187,7 +189,7 @@ The `sentrySvelteKit()` function adds Vite plugins to your Vite config to:
187189
- Automatically upload source maps to Sentry
188190
- Automatically instrument `load` functions for tracing
189191

190-
## Configure Source Maps Upload
192+
### Configure Source Maps Upload
191193

192194
By default, `sentrySvelteKit()` will add an instance of the [Sentry Vite Plugin](https://www.npmjs.com/package/@sentry/vite-plugin), to upload source maps for both server and client builds. This means that when you run a production build (`npm run build`), source maps will be generated and uploaded to Sentry, so that you get readable stack traces in your Sentry issues.
193195

@@ -255,7 +257,7 @@ export default {
255257

256258
Using the `sourceMapsUploadOptions` object is useful if the default source maps upload doesn't work out of the box, for instance, if you have a customized build setup or if you're using the SDK with a SvelteKit adapter other than the [supported adapters](../#compatibility).
257259

258-
### Overriding SvelteKit Adapter detection
260+
#### Overriding SvelteKit Adapter detection
259261

260262
By default, `sentrySvelteKit` will try to detect your SvelteKit adapter to configure source maps upload correctly.
261263
If you're not using one of the [supported adapters](../#compatibility) or the wrong one is detected, you can override the adapter detection by passing the `adapter` option to `sentrySvelteKit`:
@@ -290,7 +292,7 @@ export default {
290292
};
291293
```
292294

293-
### Disable Source Maps Upload
295+
#### Disable Source Maps Upload
294296

295297
You can disable automatic source maps upload in your Vite config:
296298

@@ -326,7 +328,7 @@ export default {
326328

327329
If you disable automatic source maps upload, you must explicitly set a `release` value in your `Sentry.init()` configs. You can also skip the `sentry-cli` configuration step below.
328330

329-
## Configure Auto-Instrumentation
331+
### Configure Auto-Instrumentation
330332

331333
The SDK primarily uses [SvelteKit's hooks](https://kit.svelte.dev/docs/hooks) to collect error and performance data. However, SvelteKit doesn't yet offer a hook for universal or server-only `load` function calls. Therefore, the SDK uses a Vite plugin to auto-instrument `load` functions so that you don't have to add a Sentry wrapper to each function manually.
332334

@@ -339,7 +341,7 @@ If you have custom Sentry code in these files, you'll have to [manually](#instru
339341

340342
</Note>
341343

342-
### Customize Auto-instrumentation
344+
#### Customize Auto-instrumentation
343345

344346
By passing the `autoInstrument` option to `sentrySvelteKit` you can disable auto-instrumentation entirely, or customize which `load` functions should be instrumented:
345347

@@ -379,7 +381,7 @@ export default {
379381
};
380382
```
381383

382-
### Disable Auto-instrumentation
384+
#### Disable Auto-instrumentation
383385

384386
If you set the `autoInstrument` option to `false`, the SDK won't auto-instrument any `load` functions. You can still [manually instrument](#instrument-load-functions-manually) specific `load` functions.
385387

@@ -413,11 +415,11 @@ export default {
413415
};
414416
```
415417

416-
### Instrument `load` Functions Manually
418+
#### Instrument `load` Functions Manually
417419

418420
If you don't want to use auto-instrumentation, you can also manually instrument specific `load` functions with the SDK's `load` function wrappers.
419421

420-
#### Universal `load` Functions
422+
##### Universal `load` Functions
421423

422424
Use the `wrapLoadWithSentry` function to wrap universal `load` functions declared in `+page.(js|ts)` or `+layout.(js|ts)`
423425

@@ -441,7 +443,7 @@ export const load = wrapLoadWithSentry(({ fetch }) => {
441443
});
442444
```
443445

444-
#### Server-only `load` Functions
446+
##### Server-only `load` Functions
445447

446448
Or use the `wrapServerLoadWithSentry` function to wrap server-only `load` functions declared in `+page.server.(js|ts)` or `+layout.server.(js|ts)`
447449

@@ -465,7 +467,7 @@ export const load = wrapServerLoadWithSentry(({ event }) => {
465467
});
466468
```
467469

468-
### Configure Client-side `fetch` Instrumentation
470+
#### Configure Client-side `fetch` Instrumentation
469471

470472
<Note>
471473

@@ -499,7 +501,7 @@ const config = {
499501
};
500502
```
501503

502-
#### Disable Client-side `fetch` Proxy Script
504+
##### Disable Client-side `fetch` Proxy Script
503505

504506
If you do not want to inject the script responsible for instrumenting client-side `load` calls, you can disable injection by passing `injectFetchProxyScript: false` to `sentryHandle`:
505507

docs/platforms/javascript/guides/wasm/index.mdx

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ categories:
99

1010
Sentry's Wasm integration enhances the Browser SDK, and allows it to provide more detailed debug information not only for the error itself, but also for the entire module it was executed from. It includes things like Debug IDs, Debug Files, Code IDs, Code Files and memory addresses.
1111

12-
### Install
12+
## Install
1313

1414
Install `@sentry/browser` and `@sentry/wasm` using `yarn` or `npm`:
1515

16-
```bash {tabTitle:npm}
17-
npm install --save @sentry/browser @sentry/wasm
18-
```
19-
2016
```bash {tabTitle:Yarn}
2117
yarn add @sentry/browser @sentry/wasm
2218
```
2319

24-
and afterwards use it like this:
20+
```bash {tabTitle:npm}
21+
npm install --save @sentry/browser @sentry/wasm
22+
```
23+
24+
## Configure
2525

2626
<SignInNote />
2727

@@ -31,22 +31,26 @@ import { wasmIntegration } from "@sentry/wasm";
3131

3232
Sentry.init({
3333
dsn: "___PUBLIC_DSN___",
34-
integrations: [wasmIntegration()],
34+
integrations: [
35+
wasmIntegration()
36+
],
3537
});
38+
```
3639

37-
// Now, whenever any code from WebAssembly module will throw an error,
38-
// it'll get captured and it'll contain all the necessary information.
40+
## Verify
3941

42+
Now, whenever any code from WebAssembly module will throw an error, it'll get captured, and it'll contain all the necessary information.
43+
44+
```javascript
4045
function executeInternalWasmStuff() {
4146
throw new Error("whoops");
4247
}
4348

4449
const { instance } = await WebAssembly.instantiateStreaming(
45-
fetch("very-complex-module.wasm"),
46-
{
50+
fetch("very-complex-module.wasm"), {
4751
env: {
4852
external_func: executeInternalWasmStuff,
49-
},
53+
}
5054
}
5155
);
5256

docs/platforms/php/guides/symfony/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ services:
5454
tags: { name: monolog.processor, handler: sentry }
5555
```
5656

57-
## Test the implementation
57+
## Verify
5858

5959
To test that both logger error and exception are correctly sent to sentry.io, you can create the following controller:
6060

docs/platforms/php/guides/symfony/metrics/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Set Up Metrics
33
description: "Learn how to measure the data points you care about by configuring Metrics in your Symfony app."
4+
sidebar_order: 5500
45
---
56

67
<Include name="feature-stage-beta-metrics.mdx" />

docs/platforms/php/index.mdx

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,23 @@ title: PHP
33
sdk: sentry.php
44
caseStyle: snake_case
55
supportLevel: production
6-
description: PHP (or Hypertext Preprocessor) is an open source, general-purpose scripting language that's well-suited for web development. It can be embedded into HTML.
6+
description: PHP (or Hypertext Preprocessor) is an open source, general-purpose scripting language that's well-suited for web development. It can be embedded into HTML.
77
---
88

9-
10-
On this page, we get you up and running with Sentry's PHP SDK, automatically reporting errors and exceptions in your application.
9+
On this page, we get you up and running with Sentry's PHP SDK, automatically reporting errors and exceptions in your application. The SDK provides support for PHP 7.2 or later. If you're using a previous version of the PHP SDK, you can access the <Link rel="nofollow" to="/platforms/php/legacy-sdk/">legacy SDK documentation</Link>.
1110

1211
<Note>
1312

1413
If you don't already have an account and Sentry project established, head over to [sentry.io](https://sentry.io/signup/), then return to this page.
1514

1615
</Note>
1716

18-
Using a framework? Check out the other SDKs we support in the left-hand dropdown.
19-
2017
<GuideGrid platform="php" />
2118

22-
## Configure the PHP SDK
23-
24-
The below Sentry PHP SDK provides support for PHP 7.2 or later. If you're using a previous version of the PHP SDK, you can access the <Link rel="nofollow" to="/platforms/php/legacy-sdk/">legacy SDK documentation</Link>.
25-
2619
Sentry captures data by using an SDK within your application’s runtime. Our SDKs are platform-specific and allow Sentry to have a deep understanding of how your application works.
2720

21+
## Install
22+
2823
<OnboardingOptionButtons
2924
options={[
3025
'error-monitoring',
@@ -33,9 +28,6 @@ Sentry captures data by using an SDK within your application’s runtime. Our SD
3328
]}
3429
/>
3530

36-
## Install
37-
In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](/product/profiling/). To enable tracing and/or profiling, click the corresponding checkmarks to get the code snippets.
38-
3931
Install the SDK using [Composer](https://getcomposer.org/).
4032

4133
```bash

platform-includes/getting-started-primer/javascript.capacitor.mdx

Whitespace-only changes.

0 commit comments

Comments
 (0)