search

getsentry / sentry-docs

Sentry's documentation (and tools to build it)
https://docs.sentry.io
Other
326 stars 1.43k forks source link

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

Open bruno-garcia opened 1 month ago

bruno-garcia commented 1 month ago

Core or SDK?

Platform/SDK

Which part? Which one?

JS

Description

As reported by a user here:

Our docs currently leads user to capture a feedback by calling first captureMessage to get the event_id. This is left over from our product capabilities before adding the ability to capture feedback outside an event.

Suggested Solution

I don't believe there's any need to show captureMessage. Since the use cases are 1: On Error, and 2: Stand alone. The message example was a 'work around' used in the past to allow users to capture a feedback stand-alone/outside an error.

We should have 2 snippets, one for each of the following use cases:

  1. Collect a user feedback at any point in time

Show the user how to call captureFeedback passing values.

  1. Collect a user feedback when an error happens.

Similar to how the crash report modal works. Originally documented this using Sentry.lastEventId and a beforeSend snippet that called captureUserFeedback.

aliu39 commented 1 month ago

Link to docs: https://docs.sentry.io/platforms/javascript/user-feedback/#user-feedback-api

bruno-garcia commented 1 month ago

Note that we claim that:

Sentry needs the eventId to be able to associate the user feedback to the corresponding event.

This is not longer true since we introduced captureFeedback (it was true for captureUserFeedback) but the docs have the example below without id as "you can add more context` so at no time we say that the id is optional now.