Skip to content
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
71f7ba9
feat: Restructure JavaScript SDK documentation organization
codyde Nov 10, 2025
3fd4f52
feat: Update sidebar ordering for key JavaScript SDK features
codyde Nov 10, 2025
408a1d8
feat: Rename Configuration to Advanced Configuration and adjust ordering
codyde Nov 10, 2025
9cb5a0d
Correcting the ordering of sidenav for javascript frameworks
codyde Nov 11, 2025
0f20a12
Improve code snippet word wrapping in SplitLayout
codyde Nov 11, 2025
3fd63a2
Strengthen word wrap overrides with more specific selectors
codyde Nov 11, 2025
2cd5009
Adding beta tag to opentelemetry support
codyde Nov 11, 2025
c0d5abf
Style fixes for sticky header
codyde Nov 11, 2025
7c81a05
Removing accidental content additions
codyde Nov 11, 2025
99759bb
duplicating pill config from prod
codyde Nov 11, 2025
93ae024
Correcting redirects
codyde Nov 11, 2025
3ded193
Style fixes to correct width / overlap issues
codyde Nov 12, 2025
9d6980a
Implementing heading text for sections in docs
codyde Nov 12, 2025
73a6a1b
sidebar section frontmatter
codyde Nov 12, 2025
e405bbd
Nav styles for sidebar
codyde Nov 12, 2025
2c51f2e
Setting ordering and configs for frontmatter in js docs
codyde Nov 12, 2025
72098ba
Nav colors, type fixing
codyde Nov 12, 2025
4b671a3
Types fix and canonical tag removal
codyde Nov 12, 2025
b6d292c
Correcting profiling ordering
codyde Nov 12, 2025
cb40949
Fixing astro profiling ordering
codyde Nov 12, 2025
1626416
Fixing profiling ordering and sourcemaps
codyde Nov 12, 2025
1b295de
restore horizontal scrolling code snippets
codyde Nov 12, 2025
84fe5b6
fixing pill text centering and padding
codyde Nov 12, 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
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: APIs
description: "Learn more about APIs of the SDK."
customCanonicalTag: "/platforms/javascript/apis/"
sidebar_order: 3
sidebar_order: 1
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Missing Sidebar Section Causes Placement Issues

The apis.mdx file is missing the sidebar_section frontmatter field. All other pages in the diff have been assigned to either features or configuration sections, but this page will appear as unsectioned, potentially placing it in an unexpected sidebar position. Given its location under configuration/ and being at sidebar_order: 1, it likely should have sidebar_section: configuration.

Fix in Cursor Fix in Web

---

This page shows all available top-level APIs of the SDK. You can use these APIs as the primary way to:
Expand Down
5 changes: 3 additions & 2 deletions docs/platforms/javascript/common/configuration/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Configuration
title: Extended Configuration
sidebar_title: Extended Configuration
description: "Learn about additional configuration options for the JavaScript SDKs."
sidebar_order: 2
sidebar_order: 10
---

<PageGrid />
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/crons/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Set Up Crons
sidebar_title: Crons
description: "Sentry Crons allows you to monitor the uptime and performance of any scheduled, recurring job in your application."
sidebar_order: 5750
sidebar_order: 13
supported:
- javascript.nextjs
- javascript.sveltekit
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/data-management/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Data Management
description: Learn about different ways to scrub data within your SDK before it gets sent to Sentry.
sidebar_order: 7
sidebar_order: 16
---

<PageGrid />
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Enriching Events
description: Add additional data to your events to make them easier to debug.
sidebar_order: 5
sidebar_order: 9
---

In addition to the data that the Sentry SDK automatically captures, you can add additional data to events to help you debug them.
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/feature-flags/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Feature Flags
sidebar_title: Feature Flags
sidebar_order: 7000
sidebar_order: 15
description: With Feature Flags, Sentry tracks feature flag evaluations in your application, keeps an audit log of feature flag changes, and reports any suspicious updates that may have caused an error.
---

Expand Down
3 changes: 2 additions & 1 deletion docs/platforms/javascript/common/logs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Set Up Logs
sidebar_title: Logs
description: "Structured logs allow you to send, view and query logs sent from your applications within Sentry."
sidebar_order: 5755
sidebar_order: 3
new: true
notSupported:
- javascript.deno
- javascript.cordova
Expand Down
3 changes: 2 additions & 1 deletion docs/platforms/javascript/common/metrics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Set Up Metrics
sidebar_title: Metrics
description: "Metrics allow you to send, view and query counters, gauges and measurements from your Sentry-configured apps to track application health and drill down into related traces, logs, and errors."
sidebar_order: 5755
sidebar_order: 4
beta: true
---

With Sentry Metrics, you can send counters, gauges, distributions, and sets from your applications to Sentry. Once in Sentry, these metrics can be viewed alongside relevant errors, and searched using their individual attributes.
Expand Down
3 changes: 2 additions & 1 deletion docs/platforms/javascript/common/opentelemetry/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: OpenTelemetry Support
description: "Learn how to use OpenTelemetry with Sentry."
sidebar_order: 7000
sidebar_order: 11
supported:
- javascript.nextjs
- javascript.node
Expand All @@ -25,6 +25,7 @@ supported:
- javascript.tanstackstart-react
notSupported:
- javascript
beta: true
---

The Sentry SDK uses [OpenTelemetry](https://opentelemetry.io/) under the hood. This means that any OpenTelemetry instrumentation that emits spans will automatically be picked up by Sentry without any further configuration.
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/profiling/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations. Get started with profiling to understand your application's performance."
notSupported:
- javascript.bun
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Sampling
description: "Learn how to configure the volume of error and transaction events sent to Sentry."
sidebar_order: 50
sidebar_order: 8
---

Adding Sentry to your app gives you a great deal of very valuable information about errors and performance you wouldn't otherwise get. And lots of information is good -- as long as it's the right information, at a reasonable volume.
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/session-replay/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Session Replay
sidebar_title: Session Replay
sidebar_order: 5500
sidebar_order: 6
notSupported:
- javascript.cordova
- javascript.wasm
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/sourcemaps/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Source Maps
sidebar_order: 3
sidebar_order: 5
description: "Upload your source maps to Sentry to enable readable stack traces in your errors."
---

Expand Down
3 changes: 2 additions & 1 deletion docs/platforms/javascript/common/tracing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Set Up Tracing
sidebar_title: Tracing
description: "Learn how to enable tracing in your app."
sidebar_order: 4000
sidebar_order: 7
section_end_divider: true
---

With [tracing](/product/insights/overview/), Sentry automatically tracks your software performance across your application services, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems.
Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/javascript/common/usage/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Capturing Errors and Events
title: Capturing Errors
description: "Learn how to use the SDK to manually capture errors and other events."
sidebar_order: 4
sidebar_order: 2
---

Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform.
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/user-feedback/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Set Up User Feedback
sidebar_title: User Feedback
description: Learn how to enable User Feedback in your app.
sidebar_order: 6000
sidebar_order: 14
og_image: /og-images/platforms-javascript-common-user-feedback.png
---

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/guides/astro/profiling/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
83 changes: 73 additions & 10 deletions docs/platforms/javascript/guides/nextjs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,19 @@ Select which Sentry features you'd like to install in addition to Error Monitori
]}
/>

## Step 1: Install
<PlatformContent includePath="getting-started-features-expandable" />

To install Sentry using the installation wizard, run the following command within your project:
<StepComponent>

```bash
npx @sentry/wizard@latest -i nextjs
```
## Install

The wizard then guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring.
<SplitLayout>
<SplitSection>
<SplitSectionText>

<PlatformContent includePath="getting-started-features-expandable" />
To install Sentry using the installation wizard, run the command on the right within your project directory.

The wizard guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring.

This guide assumes that you enable all features and allow the wizard to create an example page and route. You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later.

Expand All @@ -54,12 +56,45 @@ This guide assumes that you enable all features and allow the wizard to create a

</Expandable>

## Step 2: Configure
</SplitSectionText>
<SplitSectionCode>

```bash
npx @sentry/wizard@latest -i nextjs
```

</SplitSectionCode>
</SplitSection>
</SplitLayout>

## Configure

If you prefer to configure Sentry manually, here are the configuration files the wizard would create:

<SplitLayout>
<SplitSection>
<SplitSectionText>

### Client-Side Configuration

The wizard creates a client configuration file that initializes the Sentry SDK in your browser.

The configuration includes your DSN (Data Source Name), which connects your app to your Sentry project, and enables the features you selected during installation.

Key configuration options:

- **`sendDefaultPii`** - Adds request headers and user IP for better debugging
- **`integrations`** - Enables features like Session Replay and User Feedback
- **`enableLogs`** - Forwards console logs to Sentry
- **`tracesSampleRate`** - Controls performance monitoring sampling (1.0 = 100%)
- **`replaysSessionSampleRate`** - Captures 10% of all sessions
- **`replaysOnErrorSampleRate`** - Captures 100% of sessions with errors

The `onRouterTransitionStart` export enables automatic performance tracking for Next.js page transitions.

</SplitSectionText>
<SplitSectionCode>

```javascript {tabTitle:Client} {filename:instrumentation-client.(js|ts)}
import * as Sentry from "@sentry/nextjs";

Expand Down Expand Up @@ -111,8 +146,32 @@ export const onRouterTransitionStart = Sentry.captureRouterTransitionStart;
// ___PRODUCT_OPTION_END___ performance
```

</SplitSectionCode>
</SplitSection>

<SplitSection>
<SplitSectionText>

### Server-Side Configuration

The wizard also creates a server configuration file for Node.js and Edge runtimes.

This configuration captures errors from:
- API routes
- Server components
- Server actions
- Middleware
- Edge functions

The server configuration is simpler than the client configuration because some features (like Session Replay and User Feedback) are client-only.

**Note:** Make sure `sendDefaultPii` is set to `true` if you want to capture user context with server-side errors.

For more advanced configuration options or to set up Sentry manually, check out our [manual setup guide](/platforms/javascript/guides/nextjs/manual-setup/).

</SplitSectionText>
<SplitSectionCode>

```javascript {tabTitle:Server} {filename:sentry.server.config.(js|ts)}
import * as Sentry from "@sentry/nextjs";

Expand All @@ -139,9 +198,11 @@ Sentry.init({
});
```

For detailed manual setup instructions, see our [manual setup guide](/platforms/javascript/guides/nextjs/manual-setup/).
</SplitSectionCode>
</SplitSection>
</SplitLayout>

## Step 3: Verify Your Setup
## Verify Your Setup

<Include name="nextjs-turbopack-warning-expandable.mdx" />

Expand Down Expand Up @@ -188,3 +249,5 @@ Our next recommended steps for you are:
- [Get support](https://sentry.zendesk.com/hc/en-us/)

</Expandable>

</StepComponent>
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/guides/nuxt/profiling/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/guides/remix/profiling/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set Up Profiling
sidebar_title: Profiling
sidebar_order: 5000
sidebar_order: 12
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
---

Expand Down
16 changes: 16 additions & 0 deletions redirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -1118,6 +1118,22 @@ const userDocsRedirects = [
source: '/platforms/javascript/guides/:guide/profiling/browser-profiling/',
destination: '/platforms/javascript/guides/:guide/profiling/',
},
{
source: '/platforms/javascript/apis/',
destination: '/platforms/javascript/configuration/apis/',
},
{
source: '/platforms/javascript/guides/:guide/apis/',
destination: '/platforms/javascript/guides/:guide/configuration/apis/',
},
{
source: '/platforms/javascript/configuration/sampling/',
destination: '/platforms/javascript/sampling/',
},
{
source: '/platforms/javascript/guides/:guide/configuration/sampling/',
destination: '/platforms/javascript/guides/:guide/sampling/',
},
{
source: '/platforms/javascript/guides/:guide/profiling/node-profiling/',
destination: '/platforms/javascript/guides/:guide/profiling/',
Expand Down
Loading
Loading