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.

Sign up for GitHub

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

Jump to bottom

SDK docs for User Feedback v2 #1206

Open
bruno-garcia opened this issue Mar 26, 2024 · 3 comments
Open

SDK docs for User Feedback v2 #1206

bruno-garcia opened this issue Mar 26, 2024 · 3 comments
Assignees
@mydea

Comments

@bruno-garcia
Copy link
Member

bruno-garcia commented Mar 26, 2024 •
edited

The current User Feedback SDK is documented here: https://develop.sentry.dev/sdk/features/#user-feedback

With the new feedback product allowing for capture of feedback outside errors. With the ability to include attachments (e.g: screenshots), tags, and other user context. The protocol has been expanded.

A new API is also being done on JS. Aligning on a new function captureFeedback. The previous captureUserFeedback can be deprecated in favor of the new.

The eventId that we took before is now optional. And the plan is to rename it to something else since the feedback itself will have an id, and eventId is ambiguous.

Document the new envelope format too. Mark the old one as deprecated.

This will unblock in particular the Mobile SDKs

Relates to:

Worth linking/connecting the two docs ^
@bruno-garcia
Copy link
Member Author

Relates to:

@bruno-garcia bruno-garcia mentioned this issue Mar 26, 2024
Open
@bruno-garcia
Copy link
Member Author

Relates to:

@ryan953 ryan953 mentioned this issue Apr 30, 2024
Merged
@bruno-garcia
Copy link
Member Author

@mydea could you give us a hand with this? I believe we're ready to deprecated captureUserFeedback in favor of the new captureFeedback.

SDK engineers that have captureUserFeedback will be able to add the new function and protocol (with tags etc) and it'll improve the UX

ryan953 added a commit to getsentry/sentry-javascript that referenced this issue May 10, 2024
@ryan953 @c298lee @billyvg
docs(feedback): Add migration docs for moving from feedbackIntegratio…
4cf9742 
…n 7.x to 8.0.0 (#11731)

As the User Feedback feature moves from alpha/beta to GA some changes to
the public API have been made, and version requirements for the server
(for on-prem users) are being solidified.

Related to getsentry/develop#1206

---------

Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
Co-authored-by: Billy Vong <billyvg@users.noreply.github.com>
andreiborza pushed a commit to getsentry/sentry-javascript that referenced this issue May 16, 2024
@ryan953 @c298lee
@billyvg @andreiborza
docs(feedback): Add migration docs for moving from feedbackIntegratio…
88cbaeb 
…n 7.x to 8.0.0 (#11731)

As the User Feedback feature moves from alpha/beta to GA some changes to
the public API have been made, and version requirements for the server
(for on-prem users) are being solidified.

Related to getsentry/develop#1206

---------

Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
Co-authored-by: Billy Vong <billyvg@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mydea mydea

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bruno-garcia @mydea