SDK dev docs for User Feedback v2

[bruno-garcia]

Which section?

SDK -> Expected Feature -> User Feedback

Page URL

https://develop.sentry.dev/sdk/expected-features/#user-feedback

Description

Copying from the old repo, which got archived:

• SDK docs for User Feedback v2 develop#1206

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:

• Rename sendFeedback to captureFeedback & enhance it sentry-javascript#10953

• User Feedback - Application documentation develop#1208
  Worth linking/connecting the two docs ^

• Document protocol of new feedback: https://develop.sentry.dev/sdk/data-model/envelope-items/#user-feedback sentry#64700

• Document max length based on @aliu39 's change (specifcy units, like bytes, not characters) (fix(feedback): enforce a max message size from all sources sentry#79326)

• [User Feedback] Improve JS example by splitting 'crash report' and 'stand-alone user feedback' use cases #10822

Suggested Solution

Clarify the new API and guidelines

[aliu39]

The linked PR truncates messages to 4096 characters on Sentry backend, and doesn't error. It is not aware of bytes/encodings, since this is way after envelope processing. This is meant as a temporary measure before we add limits in the envelope schema, and dropped outcomes in Relay.

Until we have updates on the schema, I'd recommend documenting "4096 characters max per message".

[getsantry]

Routing to @getsentry/product-owners-user-feedback for triage ⏲️