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

Add "Send error log to Sentry?"

Open krystofwoldrich opened this issue 2 years ago • 7 comments

At the moment we know if an error occurred during a certain step of the wizard, but we can't act on it as we don't have any stack trace or log information.

This is by design as we don't collect any PII.

Should we add "Send error log to Sentry?" that would enable users to report custom messages or error logs (for example failed pod install)?

Example:

> Pod install failed.
> Would you like to send this error log to Sentry? Yes No
> Error log 
/opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1458:in `rescue in block in activate_dependencies': Could not find 'minitest' (>= 5.1) among 104 total gem(s) (Gem::MissingSpecError)
Checked in 'GEM_PATH=/Users/krystofwoldrich/.rvm/gems/ruby-2.7.6:/Users/krystofwoldrich/.rvm/gems/ruby-2.7.6@global:/opt/homebrew/Cellar/cocoapods/1.12.1/libexec' at: /opt/homebrew/Cellar/cocoapods/1.12.1/libexec/specifications/activesupport-7.0.4.3.gemspec, execute `gem env` for more information
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1455:in `block in activate_dependencies'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1444:in `each'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1444:in `activate_dependencies'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1426:in `activate'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1462:in `block in activate_dependencies'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1444:in `each'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1444:in `activate_dependencies'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1426:in `activate'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1462:in `block in activate_dependencies'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1444:in `each'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1444:in `activate_dependencies'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems/specification.rb:1426:in `activate'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems.rb:284:in `block in activate_bin_path'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems.rb:283:in `synchronize'
        from /opt/homebrew/Cellar/ruby/3.2.2_1/lib/ruby/3.2.0/rubygems.rb:283:in `activate_bin_path'
        from /opt/homebrew/Cellar/cocoapods/1.12.1/libexec/bin/pod:25:in `<main>'
> End of the log (only the log visible on the screen will be sent)

krystofwoldrich avatar Nov 14 '23 16:11 krystofwoldrich

  • redact user path (simple to redact)
  • send as attachment

krystofwoldrich avatar Nov 17 '23 13:11 krystofwoldrich

Great idea!

send as attachment

You mean we send the error (i.e. the redacted stack trace) as an attachment?

Lms24 avatar Nov 17 '23 15:11 Lms24

@Lms24 In the example case yes, as it's stderr of the pod install command, but if it would be a JS error I think we could capture it like any other JS error.

krystofwoldrich avatar Nov 17 '23 16:11 krystofwoldrich

Please note that error messages can also include PII so we should think twice about actually doing this.

lforst avatar Nov 22 '23 10:11 lforst

@lforst All of this should be based on needs to be confirmed by the user.

Show the error stack and message -> would you like to share this with Sentry? Yes/No

krystofwoldrich avatar Nov 27 '23 08:11 krystofwoldrich

I should learn how to read. Yes this is a great idea!

lforst avatar Nov 27 '23 09:11 lforst

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

github-actions[bot] avatar Dec 19 '23 00:12 github-actions[bot]