Skip to content

Unreal Engine: Update info about reading certain options from env vars #14714

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

Merged
merged 1 commit into from
Aug 28, 2025
Merged

Unreal Engine: Update info about reading certain options from env vars #14714

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
4 changes: 2 additions & 2 deletions docs/platforms/unreal/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ Turns debug mode on or off. If debug is enabled SDK will attempt to print out us

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable if it's not set explicitly in the plugin settings. Otherwise, the release name is automatically derived from the current project name and version to match the format `<ProjectName>@<Version>`.

</ConfigKey>

<ConfigKey name="environment">

Sets the environment. This string is freeform and not set by default. A release can be associated with more than one environment to separate them in the UI (think `staging` vs `prod` or similar).

By default the SDK will try to read this value from the `SENTRY_ENVIRONMENT` environment variable (except for the browser SDK where this is not applicable).
By default the SDK will try to read this value from the `SENTRY_ENVIRONMENT` environment variable if it's not set explicitly in the plugin settings. Otherwise, the default environment is the current application's build configuration, i.e. `Editor` or `Development`.

</ConfigKey>

Expand Down