Skip to content

Commit 949763e

Browse files
authored
Update Debug Symbols Uploading docs for Unreal Engine SDK (#13045)
* Update Debug Symbols Uploading docs for Unreal Engine SDK * Remove Sentry CLI configuration type selection
1 parent 4d85a45 commit 949763e

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed
223 KB
Loading

docs/platforms/unreal/configuration/debug-symbols/index.mdx

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,37 @@ For Android, debug symbols upload is handled by [Sentry Android Gradle Plugin](/
1111

1212
</Alert>
1313

14-
The automated debug symbols upload is disabled by default and requires configuration. To configure it, navigate to **Project Settings > Plugins > Sentry**, then enter the [Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/), Organization Slug, and Project Name. Note, that the Unreal Engine SDK automatically creates a `sentry.properties` file at the root of your project directory to store the configuration. This configuration file should **never** be made publicly available.
14+
## Automatic Upload
15+
16+
The automated debug symbols upload is disabled by default and requires configuration. To configure it, navigate to **Project Settings > Plugins > Sentry**, then enable "Upload debug symbols automatically".
17+
18+
Alternatively, debug symbol upload can be enabled by setting the `SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY` environment variable to `True`. This can be especially helpful in CI/CD environments where manual configuration is impractical.
1519

1620
<Alert>
1721

18-
You must configure which build configurations, target types, and platforms Sentry will upload debug symbols for in the "Misc" section of the plugin settings.
22+
Sentry will upload debug symbols only for build configurations and target types that are enabled in the "Misc" section of the plugin settings.
1923

2024
</Alert>
2125

2226
![The Unreal Engine debug symbols upload configuration](./img/unreal-debug-symbols.png)
2327

24-
Alternatively, debug symbol upload can be enabled by setting the `SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY` environment variable to `True`. This can be especially helpful in CI/CD environments where manual configuration is impractical.
28+
The `sentry-cli` require you to specify the organization and project to work with as well as a token to authenticate with Sentry. The Unreal Engine SDK provides two ways to configure these settings - either by using a properties file (default) or environment variables.
29+
30+
### Properties File
31+
32+
To configure the `sentry-cli` using properties file enter the [Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/), Organization Slug, and Project Name. Note, that the Unreal Engine SDK automatically creates a `sentry.properties` file at the root of your project directory to store the configuration. This configuration file should **never** be made publicly available.
33+
34+
### Environment Variables
35+
36+
The `sentry-cli` can be configured by setting the following environment variables which will be automatically picked up during the debug symbol upload if the properties file is not found:
37+
38+
```bash
39+
export SENTRY_ORG=___ORG_SLUG___
40+
export SENTRY_PROJECT=___PROJECT_SLUG___
41+
export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___
42+
```
2543

26-
### Manual Upload Using sentry-cli
44+
## Manual Upload Using sentry-cli
2745

2846
To upload debug symbols to Sentry manually, run `sentry-cli` through the command line. You can either use the provided executables from within the package, or follow the [sentry-cli documentation](/cli/installation/) to make it available globally. To upload debug symbols run the following command:
2947

0 commit comments

Comments
 (0)