Skip to content

Commit

Permalink
unreal: clarify environment defaults (#11991)
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-garcia authored Dec 5, 2024
1 parent 8176ce6 commit 007f1da
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/platforms/unreal/configuration/environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@ sidebar_order: 30
---

Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere.
It help you better filter issues, releases, and user feedback in the Issue Details page of sentry.io, which you learn more about in our [documentation that covers using environments](/product/sentry-basics/environments/).

Sentry automatically creates an environment when it receives an event with the `environment` parameter set.

Environments are case-sensitive. The environment name can't contain newlines, spaces or forward slashes, can't be the string "None", or exceed 64 characters. You can't delete environments, but you can [hide](/product/sentry-basics/environments/#hidden-environments) them.
By default, the SDK reports `Editor` when running inside the Unreal Engine Editor.
For shipping builds it'll use `Release` and in other configurations it'll use `FApp::GetBuildConfiguration()`
You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value programatically.

```cpp
FConfigureSettingsDelegate SettingsDelegate;
Expand All @@ -26,6 +29,4 @@ USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem
SentrySubsystem->InitializeWithSettings(SettingsDelegate);
```
By default, the SDK reports `Editor` when running inside the Unreal Engine Editor. You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value manually.
Environments help you better filter issues, releases, and user feedback in the Issue Details page of sentry.io, which you learn more about in our [documentation that covers using environments](/product/sentry-basics/environments/).
Environments are case-sensitive. The environment name can't contain newlines, spaces or forward slashes, can't be the string "None", or exceed 64 characters. You can't delete environments, but you can [hide](/product/sentry-basics/environments/#hidden-environments) them.

0 comments on commit 007f1da

Please sign in to comment.