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.

Sign up for GitHub

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

doc: add a doc on getting crash reporting symbols #180

Merged
merged 4 commits into from
Feb 7, 2024
Merged

doc: add a doc on getting crash reporting symbols #180

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99ff7b9
doc: add a doc on getting crash reporting symbols
eseidel Feb 2, 2024
598ae58
Fix android symbols
eseidel Feb 6, 2024
b15b9bc
Merge branch 'main' into crash_reporting
eseidel Feb 6, 2024
d5249f5
Run npm format
eseidel Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions docs/guides/crash-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
sidebar_position: 3
slug: crash-reporting
title: Crash Reporting
sidebar_label: 🚑 Crash Reporting
description: Use Shorebird with crash reporting tools
---

# Integrating with Crash Reporting Tools

Shorebird uses a fork of Flutter to build your app. This means we've built
our own copy of Flutter's engine which means that the symbols included in
the Flutter.framework or libflutter.so are slightly different from the
upstream Flutter engine.

If you would like to see C++ symbols from our fork of Flutter's engine in your crash reports, you will need to
upload the symbols to your crash reporting tool.

Google provides instructions for how to integrate various crash reporting
tools into your Flutter app:

https://docs.flutter.dev/cookbook/maintenance/error-reporting

# Getting Symbols for Shorebird's Flutter Fork

For a given Flutter version you will need the Flutter engine hash
to download the symbols. This hash is displayed in `shorebird doctor`
output:
```
% shorebird doctor
Shorebird 0.24.1 • [email protected]:shorebirdtech/shorebird.git
Flutter 3.16.7 • revision ba46e8490348d6989283c9cff2b95727f0969d04
Engine • revision 974eae888fdedd890b74c84e55a454bb7fcbd7de
```

In this case, we're using `974eae888fdedd890b74c84e55a454bb7fcbd7de` as the
engine hash.

## Symbols for iOS

Assuming engine hash `974eae888fdedd890b74c84e55a454bb7fcbd7de`, the iOS symbols can be downloaded from the following URL:

https://download.shorebird.dev/flutter_infra_release/flutter/974eae888fdedd890b74c84e55a454bb7fcbd7de/ios-release/Flutter.dSYM.zip

## Symbols for Android

Assuming engine hash `974eae888fdedd890b74c84e55a454bb7fcbd7de`, the Android symbols can be downloaded from the following URLs:

https://download.shorebird.dev/flutter_infra_release/flutter/974eae888fdedd890b74c84e55a454bb7fcbd7de/android-arm64-release/symbols.zip
https://download.shorebird.dev/flutter_infra_release/flutter/974eae888fdedd890b74c84e55a454bb7fcbd7de/android-arm-release/symbols.zip
https://download.shorebird.dev/flutter_infra_release/flutter/974eae888fdedd890b74c84e55a454bb7fcbd7de/android-x64-release/symbols.zip
Loading