Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
# /src/docs/product/discover-queries/ @getsentry/visibility
# /src/docs/product/performance/ @getsentry/visibility

# /src/docs/product/cli/dif/ @getsentry/owners-native
# /src/docs/cli/dif.mdx @getsentry/owners-native

# /.github/labels.yml @getsentry/open-source
# /.github/workflows/react-to-product-owners-yml-changes.yml @getsentry/open-source
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ There are a few important points:

## Running a Worker

Workers can be run by using the [Sentry CLI](https://docs.sentry.io/product/cli/).
Workers can be run by using the [Sentry CLI](https://docs.sentry.io/cli/).

```bash
$ sentry run worker
Expand Down
2 changes: 1 addition & 1 deletion docs/account/auth-tokens/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Learn about the different kinds of Auth Tokens Sentry provides, an
Auth tokens (short for _authentication tokens_) are a way to authenticate with Sentry. They are similar to passwords but are designed for programmatic interaction with Sentry. Some examples of what you would use auth tokens for include:

- Uploading Source Maps during your CI build
- Using [Sentry CLI](/product/cli/) to interact with Sentry
- Using [Sentry CLI](/cli/) to interact with Sentry
- Using the [Sentry API](/api/auth/)

Each auth token is created with a certain set of permissions and scopes which are mapped to the Sentry API's [Permissions & Scopes](/api/permissions/). Some types of auth tokens have set permissions that can't be edited, while others can be customized upon token creation and edited later.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ Events in Sentry are immutable and can only be deleted by deleting the whole iss

<Alert level="warning" title="Note">

Be aware that if you're using `sentry-cli` to [manage your releases](/product/cli/releases/), you'll need a token which also has `org:read` scope.
Be aware that if you're using `sentry-cli` to [manage your releases](/cli/releases/), you'll need a token which also has `org:read` scope.

</Alert>
4 changes: 2 additions & 2 deletions docs/cli/crons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Sentry Crons allows you to monitor the uptime and performance of any scheduled,

To begin monitoring your recurring, scheduled job:

- [Install](/product/cli/installation) the Sentry CLI (min v2.16.1).
- [Install](/cli/installation) the Sentry CLI (min v2.16.1).
- Create and configure your first Monitor in [Sentry](https://sentry.io/crons/create/) or [via the CLI](#creating-or-updating-a-monitor-through-a-check-in-optional).

## Configuration
Expand All @@ -36,7 +36,7 @@ Alternatively, you can add it to your `~/.sentryclirc` config:
dsn = ___PUBLIC_DSN___
```

Learn more about the CLI's [configuration file](/product/cli/configuration#configuration-file).
Learn more about the CLI's [configuration file](/cli/configuration#configuration-file).

## Job Monitoring

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/dif.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `sentry-cli` requires an [Organization Auth Token](https://sentry.io/orgredi
<Note>

Source maps, while also being debug information files, are handled
differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps).
differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps).

</Note>

Expand Down Expand Up @@ -101,7 +101,7 @@ for more information.

You need to specify the organization and project you are working with because
debug information files work on projects. For more information about this refer
to [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects).
to [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects).

</Note>

Expand Down Expand Up @@ -187,7 +187,7 @@ when you only release some of the builds you're creating.

You need to specify the organization and project you are working with
because ProGuard files work on projects. For more information about this refer to
[Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects).
[Working with Projects](/cli/configuration/#sentry-cli-working-with-projects).

</Note>

Expand Down Expand Up @@ -255,7 +255,7 @@ Java or Kotlin.
<Note>

Before you can upload source files, you must configure the Sentry CLI with the organization and project you are uploading bundle files for. See the CLI docs on
[Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects) to learn how to do this.
[Working with Projects](/cli/configuration/#sentry-cli-working-with-projects) to learn how to do this.

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ If set to `1`, the script will skip downloading the binary completely.

`SENTRYCLI_SKIP_CHECKSUM_VALIDATION`:

If set to `1`, the script will skip the checksum validation phase. You can manually verify the checksums by visiting [Build Checksums](/product/cli/installation/#build-checksums) page.
If set to `1`, the script will skip the checksum validation phase. You can manually verify the checksums by visiting [Build Checksums](/cli/installation/#build-checksums) page.

`SENTRYCLI_NO_PROGRESS_BAR`:

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Metrics help you track and visualize the data points you care about, making it e
Learn more about [Metrics](/product/explore/metrics).

## Requirements
- [Install](/product/cli/installation) the Sentry CLI (min v2.32.0).
- [Install](/cli/installation) the Sentry CLI (min v2.32.0).

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The `sentry-cli` tool can be used for release management on Sentry. It allows yo

<Note>

Because releases work on projects you will need to specify the organization and project you are working with. For more information about this refer to [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects).
Because releases work on projects you will need to specify the organization and project you are working with. For more information about this refer to [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects).

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/send-event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ eval "$(sentry-cli bash-hook)"
# rest of the script goes here
```

Alternatively you can use other mechanisms like [a `.sentryclirc` file](/product/cli/configuration/#configuration-file) to configure the DSN.
Alternatively you can use other mechanisms like [a `.sentryclirc` file](/cli/configuration/#configuration-file) to configure the DSN.
2 changes: 1 addition & 1 deletion docs/concepts/migration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Below is a non-exhaustive list of some items that will not be relocated:
- Issues
- Events
- Replays and/or other [Event Attachments](/platforms/javascript/enriching-events/attachments/)
- Source Maps, [Debug Information Files](/product/cli/dif/) and/or [Artifact Bundles](/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/)
- Source Maps, [Debug Information Files](/cli/dif/) and/or [Artifact Bundles](/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/)
- Release information, including any references to external repositories via specific Pull Requests
- Deployment information
- Custom Avatars
Expand Down
8 changes: 4 additions & 4 deletions docs/platforms/android/configuration/gradle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ sentry {

The plugin will automatically generate appropriate ProGuard mapping files and upload them when you run `gradle assemble{BuildVariant}`. For example, `assembleRelease`. Release is the default, but the plugin works for others as long as you've enabled ProGuard/R8. The credentials for the upload step are defined in the Gradle extension above or loaded from a `sentry.properties` file in your project.

To use Guardsquare's ProGuard or DexGuard tooling, you'll have to enable the `dexguardEnabled` flag. Learn more in the [full `sentry-cli` documentation](/product/cli/configuration/#configuration-values).
To use Guardsquare's ProGuard or DexGuard tooling, you'll have to enable the `dexguardEnabled` flag. Learn more in the [full `sentry-cli` documentation](/cli/configuration/#configuration-values).

Instead of providing your credentials via the Gradle extension, you can create a `sentry.properties` file with the following content under your `app` module:

Expand All @@ -385,15 +385,15 @@ auth.token=___ORG_AUTH_TOKEN___

<Note>

You can find your authentication token [on the Organization Auth Tokens](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) settings page. For more information about the available configuration options, check out the [full sentry-cli documentation](/product/cli/configuration/#configuration-values).
You can find your authentication token [on the Organization Auth Tokens](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) settings page. For more information about the available configuration options, check out the [full sentry-cli documentation](/cli/configuration/#configuration-values).

</Note>

## Native Debug Symbols and Sources

The plugin will automatically discover and upload Native debug symbols and sources when you run `gradle assemble{BuildVariant}`. The `{BuildVariant}` must be a non-debuggable build type, for example `Release`. The credentials for the upload step are loaded via environment variables or from a `sentry.properties` file in your project root.

Learn more in the [full sentry-cli documentation](/product/cli/configuration/#configuration-values).
Learn more in the [full sentry-cli documentation](/cli/configuration/#configuration-values).

At the very minimum, you will need something similar to:

Expand All @@ -407,7 +407,7 @@ auth.token=___ORG_AUTH_TOKEN___

<Note>

You can find your authentication token [on the Sentry API page](https://sentry.io/api/). For more information about the available configuration options, check out the [full sentry-cli documentation](/product/cli/configuration/#configuration-values).
You can find your authentication token [on the Sentry API page](https://sentry.io/api/). For more information about the available configuration options, check out the [full sentry-cli documentation](/cli/configuration/#configuration-values).

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/configuration/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The value can be arbitrary, but we recommend either of these naming strategies:
- `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android)
- `version` is the semver-like structure `<major>.<minor?>.<patch?>.<revision?>-<prerelease?>` (`CFBundleShortVersionString` on iOS, `versionName` on Android)
- `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android)
- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation.
- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation.

<Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports.
Still, it is always a good idea to provide all available debug information.

`sentry-cli` can be used to list properties of supported debug files and
validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information.
validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information.

## Mach-O and dSYM

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact
files that match it in the _Debug Files_ settings screen.

`sentry-cli` can help to print properties of debug information files like their
debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information.
debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information.

## GNU Build Identifiers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ the following formats:
<Note>

Source maps, while also being debug information files, are handled
differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps).
differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps).

</Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime.
By contrast, to get source context for compiled applications, the source code
needs to be uploaded alongside the debug information files.
The recommended way to do this is by using `sentry-cli`.
See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information.
See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information.

<Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/enhance-errors/proguard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 100
description: "Learn about using the Sentry Gradle Plugin or sentry-cli to upload ProGuard/R8 and DexGuard mappings to Sentry."
---

If you want to see de-obfuscated stack traces, you'll need to use [ProGuard](https://www.guardsquare.com/proguard) with Sentry. To do so, upload the ProGuard mapping files by either the recommended method of using our [Gradle integration](/platforms/android/configuration/gradle/) or manually by using [sentry-cli](/product/cli/dif/#proguard-mapping-upload).
If you want to see de-obfuscated stack traces, you'll need to use [ProGuard](https://www.guardsquare.com/proguard) with Sentry. To do so, upload the ProGuard mapping files by either the recommended method of using our [Gradle integration](/platforms/android/configuration/gradle/) or manually by using [sentry-cli](/cli/dif/#proguard-mapping-upload).

It works the same either way. A (random) UUID will be or has to be generated and placed into the `AndroidManifest.xml`. The same UUID has to be used to upload the mapping file(s). In case a crash happens in the app, the Sentry Android SDK will send the UUID along with the stack trace to the Sentry server instance. Sentry will then de-obfuscate the stack trace by searching for the associated mapping file with the same UUID.

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/migration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ The `io.sentry.android.gradle` >= `3.0.0` requires [Android Gradle Plugin >= 7.0

The `autoUpload` flag has been deprecated in favor of two new options:

- `includeProguardMapping` - Disables/enables Proguard mapping functionality. When enabled, generates a UUID and attempts to upload a Proguard mapping associated with that UUID to Sentry. When `autoUploadProguardMapping` is disabled, the plugin will only generate a `sentry-debug-meta.properties` file containing UUID, which can later be used to manually upload the mapping using, for example [sentry-cli](/product/cli/dif/#proguard-mapping-upload).
- `includeProguardMapping` - Disables/enables Proguard mapping functionality. When enabled, generates a UUID and attempts to upload a Proguard mapping associated with that UUID to Sentry. When `autoUploadProguardMapping` is disabled, the plugin will only generate a `sentry-debug-meta.properties` file containing UUID, which can later be used to manually upload the mapping using, for example [sentry-cli](/cli/dif/#proguard-mapping-upload).
- `autoUploadProguardMapping` - Defines whether the gradle plugin should attempt to auto-upload the mapping file to Sentry.
When `includeProguardMapping` is disabled, this flag has no effect.

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/troubleshooting/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ android.bundle.enableUncompressedNativeLibs=false

### Proguard Mapping Upload Issues

You can set the debug log flag as an environment variable, which is picked up by the [Sentry CLI](/product/cli/).
You can set the debug log flag as an environment variable, which is picked up by the [Sentry CLI](/cli/).
In addition, set the `--stacktrace` flag:

```
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/apple/common/configuration/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies:
- `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android)
- `version` is the semver-like structure `<major>.<minor?>.<patch?>.<revision?>-<prerelease?>` (`CFBundleShortVersionString` on iOS, `versionName` on Android)
- `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android)
- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation.
- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation.

<Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports.
Still, it is always a good idea to provide all available debug information.

`sentry-cli` can be used to list properties of supported debug files and
validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information.
validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information.

## Mach-O and dSYM

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact
files that match it in the _Debug Files_ settings screen.

`sentry-cli` can help to print properties of debug information files like their
debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information.
debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information.

## GNU Build Identifiers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ the following formats:
<Note>

Source maps, while also being debug information files, are handled
differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps).
differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps).

</Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime.
By contrast, to get source context for compiled applications, the source code
needs to be uploaded alongside the debug information files.
The recommended way to do this is by using `sentry-cli`.
See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information.
See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information.

To get source context for your Apple project, follow the instructions in the [Uploading Debug Symbols](/platforms/apple/sourcecontext) guide.

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/dart/configuration/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies:
- `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android)
- `version` is the semver-like structure `<major>.<minor?>.<patch?>.<revision?>-<prerelease?>` (`CFBundleShortVersionString` on iOS, `versionName` on Android)
- `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android)
- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation.
- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation.

<Note>

Expand Down
Loading
Loading