getsentry / sentry-docs

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

Clarify User Feedback Alert details #10982

Open sdzhong opened 1 month ago

sdzhong commented 1 month ago

Core or SDK?

Core Sentry product

Which part? Which one?

https://docs.sentry.io/product/user-feedback/#getting-user-feedback-alerts

Description

The conditions in the screenshot for User Feedback Alert do not suggest a good experience.

Having both WHEN "A new issue is created" + IF "The Issue's category is equal to Feedback" together will not provide the expected result of getting notified when User Feedback appears. Instead, you'd only get notified if it's the first appearance of that Issue and in this first appearance there was User Feedback.

Image

Suggested Solution

Update the screenshot to remove the optional trigger and caption the screenshot to describe the effects of the IF "The Issue's category is equal to Feedback" filter.

Also describe that optional WHEN triggers can be applied to refine the conditions and that the THEN actions can define where these notifications can be sent, including Sentry's Notifications & Incidents integrations.

getsantry[bot] commented 1 month ago

Assigning to @getsentry/support for routing ⏲️

sdzhong commented 1 month ago

Correction, upon reviewing the real-world use of the Alert configuration from the screenshot, it appears to provide notifications of all user feedback.

I'm now confirming how WHEN A new issue is created affects the criteria.

sdzhong commented 1 month ago

Checking internally, I've learned that each User Feedback Event is an individual/new Issue of its own. User Feedback is technically built on the Issues platform.

This is not described in the docs; i.e. User Feedback Event/Issues is not described in the Issues docs page https://docs.sentry.io/product/issues/). This is confusing to me as an end-user.