Skip to content

Conversation

@stefanosiano
Copy link
Member

DESCRIBE YOUR PR

added new User Feedback API instructions
added new User Feedback Widget configuration options

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

EXTRA RESOURCES

added new User Feedback Widget configuration options
@vercel
Copy link

vercel bot commented May 19, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2025 3:19pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jun 18, 2025 3:19pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jun 18, 2025 3:19pm

@stefanosiano stefanosiano requested a review from kahest May 19, 2025 17:13
@codeowner-assignment codeowner-assignment bot requested a review from a team May 19, 2025 17:13
@codecov
Copy link

codecov bot commented May 19, 2025

Bundle Report

Changes will increase total bundle size by 2.93kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.2MB 216 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.51MB 2.71kB (0.03%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
../app/[[...path]]/page.js.nft.json 75 bytes 396.71kB 0.02%
../app/platform-redirect/page.js.nft.json 75 bytes 396.63kB 0.02%
../app/sitemap.xml/route.js.nft.json 75 bytes 394.6kB 0.02%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
static/media/cd914ecf9c9071d5-*.p.woff2 (New) 36.44kB 36.44kB 100.0% 🚀
static/media/0a86735c6520d94f-*.p.woff2 (New) 35.32kB 35.32kB 100.0% 🚀
static/media/4fca85807f6c09f6-*.woff2 (New) 32.6kB 32.6kB 100.0% 🚀
static/media/d695df15e3ff125c-*.woff2 (New) 32.58kB 32.58kB 100.0% 🚀
static/media/acdf4f392b58827a-*.woff2 (New) 21.13kB 21.13kB 100.0% 🚀
static/media/501d9eeee6e2b0cc-*.woff2 (New) 19.41kB 19.41kB 100.0% 🚀
static/media/e136059a869f199b-*.woff2 (New) 16.46kB 16.46kB 100.0% 🚀
static/media/c1b11e140b58cf5a-*.woff2 (New) 15.11kB 15.11kB 100.0% 🚀
static/media/434c0c74b95acb46-*.woff2 (New) 13.66kB 13.66kB 100.0% 🚀
static/media/60181e10ad16e354-*.woff2 (New) 12.29kB 12.29kB 100.0% 🚀
static/media/a72efd2c2476ebb2-*.woff2 (New) 9.7kB 9.7kB 100.0% 🚀
static/media/9d7436bc73437f75-*.woff2 (New) 9.36kB 9.36kB 100.0% 🚀
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.55kB 1.0kB -84.74%
static/j2KKv0sHcy23f9H_6Wlzw/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/j2KKv0sHcy23f9H_6Wlzw/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/media/b9378c7268e717c1-*.p.woff2 (Deleted) -36.52kB 0 bytes -100.0% 🗑️
static/media/c22ccc5eb58b83e1-*.p.woff2 (Deleted) -35.32kB 0 bytes -100.0% 🗑️
static/media/f1fcc5ff05fc0d5e-*.woff2 (Deleted) -32.42kB 0 bytes -100.0% 🗑️
static/media/356abdd51b933898-*.woff2 (Deleted) -32.26kB 0 bytes -100.0% 🗑️
static/media/8be5568353d67f1e-*.woff2 (Deleted) -20.82kB 0 bytes -100.0% 🗑️
static/media/0596140cb8d9223a-*.woff2 (Deleted) -19.09kB 0 bytes -100.0% 🗑️
static/media/6551d72ebeeac6a7-*.woff2 (Deleted) -16.3kB 0 bytes -100.0% 🗑️
static/media/341baa6ce7a16e81-*.woff2 (Deleted) -15.08kB 0 bytes -100.0% 🗑️
static/media/2a54da80dbfac484-*.woff2 (Deleted) -13.62kB 0 bytes -100.0% 🗑️
static/media/1a4dd1d7cd3232ea-*.woff2 (Deleted) -12.29kB 0 bytes -100.0% 🗑️
static/media/ee8ee7e184152fe5-*.woff2 (Deleted) -8.94kB 0 bytes -100.0% 🗑️
static/media/d70c23d6fe66d464-*.woff2 (Deleted) -8.69kB 0 bytes -100.0% 🗑️
static/-*.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

### Form Labels Configuration

You can customize tha labels and placeholders used in the form.
Note: manifest options are not supported here, due to internationalization:
Copy link
Contributor

@buenaflor buenaflor May 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe the note should be an <Alert>, up to you

@stefanosiano stefanosiano requested review from markushi and romtsn May 20, 2025 09:57
Comment on lines +15 to +20
| Hook | Type | Description |
| ----------------- | ------------------------- | ------------------------------------------------------------------------ |
| `onFormOpen` | `() -> Void` | Called when the feedback form is opened. |
| `onFormClose` | `() -> Void` | Called when the feedback form is closed. |
| `onSubmitSuccess` | `(Feedback) -> Void` | Called when feedback is successfully submitted via the prepared form. |
| `onSubmitError` | `(Feedback) -> Void` | Called when there is an error submitting feedback via the prepared form. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the tables 👍

we should use those more often in docs where it makes sense 🤔

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for adding!

added associatedEventId in sample code snippets
updated java/android sdk-api-example

### Session Replay

The User Feedback widget integrates seamlessly with Session Replay. When the widget is opened, the SDK buffers up to 30 seconds of the user's session. If feedback is submitted, this replay is sent along with the feedback, allowing you to view both the feedback and the user's actions leading up to the feedback submission.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The User Feedback widget integrates seamlessly with Session Replay. When the widget is opened, the SDK buffers up to 30 seconds of the user's session. If feedback is submitted, this replay is sent along with the feedback, allowing you to view both the feedback and the user's actions leading up to the feedback submission.
The User Feedback widget integrates seamlessly with Session Replay. The SDK buffers up to 30 seconds of the user's session; if feedback is submitted, this replay is sent along with the feedback, allowing you to view both the feedback and the user's actions leading up to the feedback submission.

I think it's a bit misleading, the SDK buffers replay even without the widget being opened

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true, but if the widget is opened, a replay is captured, and then it's not captured again when the feedback is sent.
But that's technical details, so i'm fine to simplify the wording

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so wait, we capture replay just by opening the widget? What if user just closes it without sending anything?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in that case we send the replay anyway. Should i change it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 do we do this across all platforms?

Copy link
Member Author

@stefanosiano stefanosiano Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clarified with the others. We send the replay regardless of the feedback being sent

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jumping in here after a discussion in Slack: We are not doing it yet for Cocoa.
See this issue: getsentry/sentry-cocoa#5425

@stefanosiano stefanosiano enabled auto-merge (squash) June 18, 2025 15:03
@stefanosiano stefanosiano merged commit d81f168 into master Jun 18, 2025
12 checks passed
@stefanosiano stefanosiano deleted the stefanosiano/android-user-widget branch June 18, 2025 15:19
antonpirker pushed a commit that referenced this pull request Jun 24, 2025
added new Android User Feedback API instructions and widget configuration options
bitsandfoxes pushed a commit that referenced this pull request Jul 3, 2025
added new Android User Feedback API instructions and widget configuration options
@github-actions github-actions bot locked and limited conversation to collaborators Jul 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants