Skip to content

Update javascript sourcemaps documentation #14496

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

Draft
szokeasaurusrex wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update javascript sourcemaps documentation #14496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 9 additions & 13 deletions platform-includes/sourcemaps/legacy-troubleshooting/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
Setting up source maps can be tricky, but it's worth it to get it right. To troubleshoot your source maps set up, you can either:
Setting up source maps can be tricky, but it's worth it to get it right. To troubleshoot your source maps setup, you can use our built-in sourcemaps debugger modal directly in the Sentry product, or follow the manual steps listed below.

1. Use our automated verification tool inside `sentry-cli`, or
2. Follow the manual steps listed below
## Use the Sourcemaps Debugger Modal

## Use the Sentry CLI
Sentry provides a built-in sourcemaps debugger modal that you can access directly from the **Issue Details** page. This tool helps you understand why your source maps might not be working correctly.

To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io).
To use the debugger modal:

For example, "Event ID: c2ad049f":
1. Navigate to an issue in your Sentry project
2. Click on the **Issue Details** page
3. Look for the sourcemaps debugger option in the interface
4. The debugger will analyze your source maps and provide detailed information about any issues

![Image highlighting where to find the ID of an event on Sentry](./img/event_id.png)

```shell
sentry-cli sourcemaps explain c2ad049fd9e448ada7849df94575e019
```

The CLI output should give you useful information about what went wrong with your source maps setup.
This is the recommended approach for troubleshooting source maps issues as it provides real-time analysis and doesn't require any CLI tools.

<PlatformSection notSupported={["javascript.electron"]}>

Expand Down
28 changes: 9 additions & 19 deletions platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,30 +269,20 @@ Sentry.init({

If you followed all of the steps above but still have issues setting up source maps using the legacy method this section will try to help troubleshoot your setup.

To troubleshoot your source maps set up, you can either:
To troubleshoot your source maps setup, you can use our built-in sourcemaps debugger modal directly in the Sentry product, or follow the manual steps listed below.

1. Use our automated verification tool inside `sentry-cli`, or
2. Follow the manual steps listed below
### Use the Sourcemaps Debugger Modal

### Use the Sentry CLI
Sentry provides a built-in sourcemaps debugger modal that you can access directly from the **Issue Details** page. This tool helps you understand why your source maps might not be working correctly.

To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io).
To use the debugger modal:

<Alert title="Note" level="warning">
1. Navigate to an issue in your Sentry project
2. Click on the **Issue Details** page
3. Look for the sourcemaps debugger option in the interface
4. The debugger will analyze your source maps and provide detailed information about any issues

The `sourcemaps explain` command requires an auth token with the following scopes: `project:admin`, `release:admin`, `event:read`, and `organization:read`. We recommend creating an [internal integration token](/organization/integrations/integration-platform/internal-integration/) over a personal token.

</Alert>

For example, "Event ID: c2ad049f":

![Image highlighting where to find the ID of an event on Sentry](./img/event_id.png)

```shell
sentry-cli sourcemaps explain c2ad049fd9e448ada7849df94575e019
```

The CLI output should give you useful information about what went wrong with your source maps setup.
This is the recommended approach for troubleshooting source maps issues as it provides real-time analysis and doesn't require any CLI tools.

<PlatformSection notSupported={["javascript.electron"]}>

Expand Down
23 changes: 9 additions & 14 deletions platform-includes/sourcemaps/troubleshooting/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,25 +30,20 @@ Dependency versions that require the legacy method of uploading source maps incl

</Alert>

Setting up source maps can be tricky, but it's worth it to get it right. To troubleshoot your source maps set up, you can either:
Setting up source maps can be tricky, but it's worth it to get it right. To troubleshoot your source maps setup, you can use our built-in sourcemaps debugger modal directly in the Sentry product, or follow the manual steps listed below.

1. Use our automated verification tool inside `sentry-cli`, or
2. Follow the manual steps listed below
## Use the Sourcemaps Debugger Modal

## Use the CLI
Sentry provides a built-in sourcemaps debugger modal that you can access directly from the **Issue Details** page. This tool helps you understand why your source maps might not be working correctly.

To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io).
To use the debugger modal:

For example, "Event ID: c2ad049f":
1. Navigate to an issue in your Sentry project
2. Click on the **Issue Details** page
3. Look for the sourcemaps debugger option in the interface
4. The debugger will analyze your source maps and provide detailed information about any issues

![Image highlighting where to find the ID of an event on Sentry](./img/event_id.png)

```shell
sentry-cli sourcemaps explain c2ad049fd9e448ada7849df94575e019
```

The CLI output should give you useful information about what went wrong with your source maps setup.
If it doesn't, let us know by filing an issue on our [Sentry CLI repo](https://github.com/getsentry/sentry-cli) so we can make it better.
This is the recommended approach for troubleshooting source maps issues as it provides real-time analysis and doesn't require any CLI tools.

## Follow Manual Steps

Expand Down