Skip to content

Commit 6db67a6

Browse files
authored
unreal: Improve environment doc (#12062)
* unreal: Improve environment doc * Update docs/platforms/unreal/configuration/environments.mdx
1 parent 649dcd9 commit 6db67a6

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/platforms/unreal/configuration/environments.mdx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ description: "Learn how to configure your SDK to tell Sentry about your environm
44
sidebar_order: 30
55
---
66

7-
Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere.
8-
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/).
7+
Environments in Sentry let you know where an error occurred, (such as in production, staging server, or another location).
8+
They make it easier to filter issues, releases, and user feedback on the Issue Details page, (which you can navigate to by clicking any issue on the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page). To learn more, read our docs about [using environments](/product/sentry-basics/environments/).
99

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

12-
By default, the SDK reports `Editor` when running inside the Unreal Engine Editor.
13-
For shipping builds it'll use `Release` and in other configurations it'll use `FApp::GetBuildConfiguration()`
14-
You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value programatically.
12+
When running inside the Unreal Engine Editor, the SDK reports the environment as `Editor`. For shipping builds, it defaults to `Release`.
13+
In other configurations it uses the `FApp::GetBuildConfiguration()`.
14+
You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration, or override it programmatically.
1515

1616
```cpp
1717
FConfigureSettingsDelegate SettingsDelegate;
@@ -29,4 +29,11 @@ USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem
2929
SentrySubsystem->InitializeWithSettings(SettingsDelegate);
3030
```
3131
32-
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.
32+
**Important things to note about environments:**
33+
34+
- Environment names are case-sensitive.
35+
- Names cannot include new lines, spaces, or forward slashes.
36+
- Certain strings, like "None", aren't allowed.
37+
- The maximum length for an environment name is 64 characters.
38+
- Environments can't be deleted, but can be [hidden](/product/sentry-basics/environments/#hidden-environments) if no longer needed.
39+

0 commit comments

Comments
 (0)