From 007f1da7164d9d8c5ec74c93d45ef295962cc9de Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Thu, 5 Dec 2024 11:28:42 -0500 Subject: [PATCH] unreal: clarify environment defaults (#11991) --- docs/platforms/unreal/configuration/environments.mdx | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/platforms/unreal/configuration/environments.mdx b/docs/platforms/unreal/configuration/environments.mdx index 0fae1b2e6b631..f531dd4c1e68e 100644 --- a/docs/platforms/unreal/configuration/environments.mdx +++ b/docs/platforms/unreal/configuration/environments.mdx @@ -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; @@ -26,6 +29,4 @@ USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystemInitializeWithSettings(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.