Skip to content
Merged
Changes from all commits
Commits
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
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere.
Environments in Sentry let you know where an error occurred, (such as in production, staging server, or another location).

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/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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/).
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/).


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()`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For shipping builds it'll use `Release` and in other configurations it'll use `FApp::GetBuildConfiguration()`
For shipping builds it'll use `Release` and in other configurations it'll use `FApp::GetBuildConfiguration()`.

Comment on lines +12 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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()`
When running inside the Unreal Engine Editor, the SDK reports the environment as `Editor`. For shipping builds, it defaults to `Release`. In other configurations it uses the `FApp::GetBuildConfiguration()`.

You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value programatically.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value programatically.
You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration, or override it programmatically.


```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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
**Important things to note about environments:**
- Environment names are case-sensitive.
- Names cannot include new lines, spaces, or forward slashes.
- Certain strings, like "None", aren't allowed.
- The maximum length for an environment name is 64 characters.
- Environments can't be deleted, but can be [hidden](/product/sentry-basics/environments/#hidden-environments) if no longer needed.