-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
fix(unreal): Add Unreal (gaming platforms) to supported replay categories #120616
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mujacica
wants to merge
2
commits into
master
Choose a base branch
from
fix/unreal-replay
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+96
−3
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| import {ExternalLink} from '@sentry/scraps/link'; | ||
|
|
||
| import type {OnboardingConfig} from 'sentry/components/onboarding/gettingStartedDoc/types'; | ||
| import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/types'; | ||
| import {t, tct} from 'sentry/locale'; | ||
|
|
||
| const getConfigureIniSnippet = () => `[/Script/Sentry.SentrySettings] | ||
| AttachSessionReplay=True`; | ||
|
|
||
| export const sessionReplay: OnboardingConfig = { | ||
| install: () => [ | ||
| { | ||
| type: StepType.INSTALL, | ||
| content: [ | ||
| { | ||
| type: 'text', | ||
| text: tct( | ||
| 'Session Replay is available in the Sentry Unreal Engine SDK. Make sure the Sentry plugin is installed and configured by following the [link:Unreal Engine setup guide] before enabling Session Replay.', | ||
| { | ||
| link: <ExternalLink href="https://docs.sentry.io/platforms/unreal/" />, | ||
| } | ||
| ), | ||
| }, | ||
| { | ||
| type: 'alert', | ||
| alertType: 'info', | ||
| showIcon: false, | ||
| text: t('Session Replay for Unreal Engine is currently experimental.'), | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| configure: () => [ | ||
| { | ||
| type: StepType.CONFIGURE, | ||
| content: [ | ||
| { | ||
| type: 'text', | ||
| text: tct( | ||
| 'Enable Session Replay from the Sentry configuration window by going to [strong:Project Settings > Plugins > Sentry] and toggling the [strong:Enable session replay (experimental)] option.', | ||
| {strong: <strong />} | ||
| ), | ||
| }, | ||
| { | ||
| type: 'text', | ||
| text: t( | ||
| 'Alternatively, you can enable Session Replay by adding the following to your project config file:' | ||
| ), | ||
| }, | ||
| { | ||
| type: 'code', | ||
| language: 'ini', | ||
| code: getConfigureIniSnippet(), | ||
| }, | ||
| { | ||
| type: 'text', | ||
| text: tct( | ||
| 'You can tune the replay duration, target framerate, and target bitrate from the same settings window. For the full list of options, see the [link:Session Replay documentation].', | ||
| { | ||
| link: ( | ||
| <ExternalLink href="https://docs.sentry.io/platforms/unreal/session-replay/" /> | ||
| ), | ||
| } | ||
| ), | ||
| }, | ||
| { | ||
| type: 'alert', | ||
| alertType: 'warning', | ||
| showIcon: false, | ||
| text: t( | ||
| 'Unlike our browser and mobile SDKs, the Unreal Engine SDK does not automatically mask sensitive content in the recorded footage. Make sure no sensitive information is displayed while Session Replay is enabled.' | ||
| ), | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| verify: () => [], | ||
| nextSteps: () => [], | ||
| }; |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.