[go: nahoru, domu]

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor the 'Report errors to a service' page #2315

Open
neiljaywarner opened this issue Jan 30, 2019 · 14 comments
Open

Refactor the 'Report errors to a service' page #2315

neiljaywarner opened this issue Jan 30, 2019 · 14 comments
Labels
a.cookbook Relates to a cookbook recipe or guide e2-days Effort: < 5 days fix.code-sample Needs new or updated code sample from.page-issue Reported in a reader-filed concern p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.diagnostics Relates to diagnostics or analysis of app t.firebase Relates to Firebase or FlutterFire

Comments

@neiljaywarner
Copy link
neiljaywarner commented Jan 30, 2019

Page URL: https://docs.flutter.dev/cookbook/maintenance/error-reporting
Page source: https://github.com/flutter/website/tree/master/src/docs/cookbook/maintenance/error-reporting.md

Description:
This page leaves you with a confused feeling if you've never used Sentry - its popularity relative to Crashhlytics is probably very low

@sfshaza2 sfshaza2 added a.cookbook Relates to a cookbook recipe or guide e1-hours Effort: < 8 hrs p2-medium Necessary but not urgent concern. Resolve when possible. labels Jan 30, 2019
@sfshaza2
Copy link
Contributor

@brianegan

@brianegan
Copy link
Contributor
brianegan commented Jan 31, 2019

Thanks, @neiljaywarner -- it's a fair point! The reason I didn't use crashlytics: At the time, the Flutter team had only provided the Sentry plugin and no Crashlytics plugins existed.

It looks like there are now a couple of different plugins available on Pub that support crashlytics, but it's funny, I've continued to use sentry myself b/c it was working well for me and haven't evaluated them closely!

@sfshaza2 What are your thoughts on creating a recipe specifically for Crashlytics? If I do, how should I choose between the available plugins on pub -- I can definitely perform a general review of the code, maintenance, etc and make a subjective assessment. However, I wasn't sure if that was good enough in this case, since this could set an "accidental" standard that this is the Crashlytics plugin "The Flutter Team Endorses."

@brianegan
Copy link
Contributor
brianegan commented Mar 11, 2019

@Sfshaza Any more thoughts from you or the team on this one? I think I recently saw an official crashlytics plugin being developed, for example.

@atsansone atsansone added the from.page-issue Reported in a reader-filed concern label May 19, 2023
@atsansone atsansone changed the title 'Report errors to a service' page issue Add Crashlytics to the 'Report errors to a service' page May 23, 2023
@atsansone
Copy link
Contributor

@brianegan : It looks like a Firebase Crashlytics package exists. Should we look to integrate this into the docs?

@atsansone atsansone added t.diagnostics Relates to diagnostics or analysis of app act.question Relates to issues that writers need SME help st.triage.ltw Indicates Lead Tech Writer has triaged labels May 23, 2023
@neiljaywarner
Copy link
Author
neiljaywarner commented May 23, 2023 via email

@brianegan
Copy link
Contributor
brianegan commented May 25, 2023

@atsansone Yah, totally makes sense now that there's a supported first-party / flutter favorite package. My previous comment was 4 years old before there was an official package.

Overall, the popularity difference between Crashlytics and Sentry doesn't look monumental (98% popularity compared to 100% popularity).

Therefore, perhaps keeping & renaming the current recipe and adding another recipe for Crashlytics might make sense?

@sfshaza2
Copy link
Contributor

@miquelbeltran, please review

@sfshaza2 sfshaza2 added the fix.code-sample Needs new or updated code sample label Jul 13, 2023
@miquelbeltran
Copy link
Member

Personally, I am not sure if a cookbook recipe is required here when the official docs from the product pages, e.g. https://firebase.google.com/docs/crashlytics/get-started?platform=flutter already cover this and are up to date.

I think we could replace the Sentry tutorial part with links to the official documentation, like we do in the Stage Management options list: https://docs.flutter.dev/data-and-backend/state-mgmt/options so we don't promote one over the other.

@ericwindmill
Copy link
Contributor

I agree with Miguels comment here. Given that the official docs are thorough, I would rather not add to our maintenance load. I also agree with the original comment: Sentry is far less popular than Crashlytics.

I recommend we either remove the Sentry recipe altogether and replace it with nothing, or we add a link to the both the Sentry and Crashlytics docs somewhere.

@sfshaza2 @atsansone WDYT?

@parlough
Copy link
Member

I think it's fine to remove the Sentry recipe and not add one for Crashlytics, instead adding a general section titled something like "Track app crashes and errors" to https://docs.flutter.dev/testing/errors. It could also be a new page.

The section could talk a little background about why, and then link to the resources for various providers (Sentry, Crashlytics, Datadog, etc).

@ericwindmill
Copy link
Contributor

I think it's fine to remove the Sentry recipe and not add one for Crashlytics, instead adding a general section titled something like "Track app crashes and errors" to https://docs.flutter.dev/testing/errors. It could also be a new page.

The section could talk a little background about why, and then link to the resources for various providers (Sentry, Crashlytics, Datadog, etc).

This sounds like a good plan to me.

I also did my due diligence, and they Sentry cookbook is among the ~10 lowest performing pages, measured by pageviews.

@neiljaywarner
Copy link
Author
neiljaywarner commented May 21, 2024 via email

@atsansone atsansone assigned parlough and unassigned ericwindmill May 30, 2024
@atsansone
Copy link
Contributor

@parlough : I'll leave it to you to refactor changes in this space. Thanks!

@atsansone atsansone changed the title Add Crashlytics to the 'Report errors to a service' page Refactor the 'Report errors to a service' page May 30, 2024
@atsansone atsansone added e2-days Effort: < 5 days and removed e1-hours Effort: < 8 hrs labels May 30, 2024
@parlough parlough removed their assignment May 30, 2024
@parlough
Copy link
Member

I'm not going to have time to work on this any time soon, so I'm unassigning myself. Happy to help anyone that wants to tackle this though, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.cookbook Relates to a cookbook recipe or guide e2-days Effort: < 5 days fix.code-sample Needs new or updated code sample from.page-issue Reported in a reader-filed concern p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.diagnostics Relates to diagnostics or analysis of app t.firebase Relates to Firebase or FlutterFire
Projects
None yet
Development

No branches or pull requests

7 participants