sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Expand on the ability to store minidumps

Open bruno-garcia opened this issue 1 year ago • 2 comments

Which part? Which one?

Native/Minidump/Unreal/Unity

Description

This ticket is the documentation part of a larger issue related to confused users about minidump support. Please for context read:

  • https://github.com/getsentry/sentry/issues/79395

tl;dr:

We should mention the ability to opt-in for persisting minidumps at places that make sense.

This exists today only under Native/Enriching Events/Attachments (note, note on Unreal and Unity). Also note it doesn't use the word minidump in the copy, which adds to the confusion.

Places we should considering adding a note or section:

  1. Minidump docs and/or Data Management / Sensitive Data
  2. Unity's 'native' docs and/or Data Management / Sensisitve Data
  3. Unreal Engine docs, Crash Reporter Client and Data Management / Sensitive Data

Suggested Solution

Suggestions:

  1. Move Enriching Events -> Attachment section about storing minidumps under Data Management (or add new content from a different angle)
  2. Add that section to Unreal and Unity docs too (clarify on which OS's we capture minidumps)
  3. Add a <Note> at places where it makes sense indicating minidumps storage is opt-in, like Getting Started, Unity Native, and other pages listed above

bruno-garcia avatar Oct 20 '24 15:10 bruno-garcia

Routing to @getsentry/product-owners-sdks-native for triage ⏲️

getsantry[bot] avatar Oct 20 '24 15:10 getsantry[bot]

Routing to @getsentry/product-owners-settings-security-privacy for triage ⏲️

getsantry[bot] avatar Oct 20 '24 15:10 getsantry[bot]