Skip to content
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

Show support information for a user #94

Closed
maikReal opened this issue Nov 8, 2022 · 3 comments
Closed

Show support information for a user #94

maikReal opened this issue Nov 8, 2022 · 3 comments
Assignees
Labels

Comments

@maikReal
Copy link

maikReal commented Nov 8, 2022

Epic: Add Version, Support ID and Job ID for debugging and better support

In order to improve troubleshooting for issues that occur on users' side, we can add a support id for each user session.

  • Support id should be always visible in the app along with the full version number (version and hash of the commit) of the deployment.
  • Support id should be also shown in each error modal window appearing in UI
  • For the operations, where Job id is known, it should also be shown in the error windows.
  • Where possible, error windows should also show a description of the error.

How to show the version and support id?

  • Web: vX.XX.X
  • Library: vX.XX.X
  • Relayer: vX.XX.X
  • Support ID: XXXXXXXX

Example:

Image

Details:

  • Issue a unique Support ID ( UUID v4) for all sessions, send it to Sentry logs
  • Show Support ID in the app permanently in the bottom
  • Show app version permanently in the bottom (Web, Library, Relayer)
  • Show Support ID in all error messages and Support ID + Job ID in the error messages that relate to specific jobs

Relates to:

@tgladilina
Copy link
Collaborator

@maxaleks
Copy link
Collaborator

Relayer version added

@maxaleks maxaleks assigned vadimnikonov1 and unassigned maxaleks Jan 10, 2023
@vadimnikonov1
Copy link

QA review - OK

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants