unreal: clarify environment defaults #11991
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will increase total bundle size by 255.64kB (1.3%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
tustanivsky
reviewed
Nov 29, 2024
|
|
||
| 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()` |
Collaborator
There was a problem hiding this comment.
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()`. |
tustanivsky
approved these changes
Nov 29, 2024
lizokm
approved these changes
Dec 2, 2024
Contributor
lizokm
left a comment
lizokm
left a comment
There was a problem hiding this comment.
Thanks for updating this! I've left some wording suggestions.
| sidebar_order: 30 | ||
| --- | ||
|
|
||
| Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere. |
Contributor
There was a problem hiding this comment.
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). |
| --- | ||
|
|
||
| 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/). |
Contributor
There was a problem hiding this comment.
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/). |
| 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. |
Contributor
There was a problem hiding this comment.
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. | |
Comment on lines
+12
to
+13
| 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()` |
Contributor
There was a problem hiding this comment.
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()`. |
| 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. |
Contributor
There was a problem hiding this comment.
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. |
Member
Author
oh no I merged this on mobile and didn't realize the suggestions. I'm on pto will make the fixes once I'm back. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reodered things a bit and added the values mentioned by @tustanivsky on the linked ticket
Resolves: