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

(feat)Update and reorganize Flutter dSYM Docs #12976

Merged
merged 28 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
e3408a9
sloppy draft
smeubank Mar 11, 2025
5c0d6fc
dart to common
smeubank Mar 11, 2025
6816bdc
remove changes
smeubank Mar 11, 2025
5c635c9
config radio buttons
smeubank Mar 12, 2025
84395e8
Update debugSymbolConfig.tsx
smeubank Mar 12, 2025
94bffc8
[getsentry/action-github-commit] Auto commit
getsantry[bot] Mar 12, 2025
ca161e6
Update debugSymbolConfig.tsx
smeubank Mar 12, 2025
4fd4308
Merge branch '(feat)flutter-dbsym-rework' of https://github.com/getse…
smeubank Mar 12, 2025
dfd0a8e
[getsentry/action-github-commit] Auto commit
getsantry[bot] Mar 12, 2025
089ca3f
Update debugSymbolConfig.tsx
smeubank Mar 12, 2025
bb691cf
Merge branch '(feat)flutter-dbsym-rework' of https://github.com/getse…
smeubank Mar 12, 2025
d0b7b34
[getsentry/action-github-commit] Auto commit
getsantry[bot] Mar 12, 2025
27c162e
extend onboarding component
smeubank Mar 13, 2025
8818594
[getsentry/action-github-commit] Auto commit
getsantry[bot] Mar 13, 2025
07c9193
Update redirects.js
smeubank Mar 13, 2025
62a4660
Merge branch '(feat)flutter-dbsym-rework' of https://github.com/getse…
smeubank Mar 13, 2025
e098efd
Update docs/platforms/dart/common/debug-symbols/index.mdx
smeubank Mar 13, 2025
25ad96d
Update docs/platforms/dart/guides/flutter/debug-symbols/index.mdx
smeubank Mar 13, 2025
697c62b
Update docs/platforms/dart/common/debug-symbols/index.mdx
smeubank Mar 13, 2025
c503940
Update platform-includes/debug-symbols/dart-plugin/dart.mdx
smeubank Mar 14, 2025
e2a2d4c
Update platform-includes/debug-symbols/dart-plugin/flutter.mdx
smeubank Mar 17, 2025
4bec4d2
resolving feedback
smeubank Mar 17, 2025
30eccfa
Merge branch '(feat)flutter-dbsym-rework' of https://github.com/getse…
smeubank Mar 17, 2025
69c12cc
add warning for dart dSYM support
smeubank Mar 17, 2025
b7a1d75
removed
smeubank Mar 17, 2025
8bc80e7
Update platform-includes/debug-symbols/dart-plugin/dart.mdx
smeubank Mar 17, 2025
966f6e3
better
smeubank Mar 17, 2025
192fbb7
Merge branch '(feat)flutter-dbsym-rework' of https://github.com/getse…
smeubank Mar 17, 2025
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configuration
description: "Additional configuration options for the SDK."
sidebar_order: 5
sidebar_order: 4
---

<PageGrid />
9 changes: 9 additions & 0 deletions docs/platforms/dart/common/debug-symbols/dart-plugin.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Sentry Dart Plugin
description: "Learn how to use the Sentry Dart Plugin to automatically upload debug symbols for your Dart application."
sidebar_order: 1
---

The [Sentry Dart Plugin](https://github.com/getsentry/sentry-dart-plugin) is the recommended way to upload debug symbols for Dart applications. It automates the upload process for Android, iOS, macOS, and Web, making it seamless to provide Sentry with the necessary files for symbolication.

<PlatformContent includePath="debug-symbols/dart-plugin" />
37 changes: 37 additions & 0 deletions docs/platforms/dart/common/debug-symbols/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Debug Symbols
description: "Learn about uploading debug symbols to enable symbolication of stack traces in your Dart applications."
sidebar_order: 3
---

Debug symbols are essential for understanding stack traces in your Dart application when errors occur. Without debug symbols, stack traces from minified or obfuscated code can be difficult or impossible to interpret.

## What Are Debug Symbols?

Debug symbols provide the necessary information to convert program addresses back to function names, source file names, and line numbers. When you build a Dart application, especially with obfuscation or optimization enabled, this information is typically removed from the main application bundle to reduce size.

In Dart applications, debug symbols can include:

- **For Dart code**: Symbol files generated when using `--split-debug-info` and `--obfuscate` flags
- **For iOS/macOS**: dSYM files
- **For Android**: Proguard/R8 mapping files and symbols files
- **For Flutter Web**: Source maps
- **For Android NDK**: ELF DWARF debug files

## When to Upload Debug Symbols

With default settings, complete stack traces are available in your Dart errors out of the box, unless you use [`split-debug-info`](https://flutter.dev/docs/perf/app-size#reducing-app-size) and [`obfuscate`](https://flutter.dev/docs/deployment/obfuscate) flags. In these cases, you must upload the debug information files generated by the build, so Sentry can show proper stack traces.

## Upload Methods

Sentry offers several methods to upload debug symbols for Dart applications:

1. **[Sentry Dart Plugin (Recommended)](/platforms/dart/debug-symbols/dart-plugin)** - The easiest way to automatically upload debug symbols for iOS, Android, Desktop and Web.

2. **[Manual Upload Options](/platforms/dart/debug-symbols/manual-upload):**
- [iOS and macOS](/platforms/apple/dsym/) - Upload dSYM files for symbolication of Apple platform crashes.
- [Android](/cli/dif/#uploading-files) - Upload mapping files manually using the Sentry CLI.
- [Android NDK](/cli/dif/#uploading-files) - Upload ELF DWARF debug files for native code crashes.
- [Web](/cli/releases/#upload-source-maps) - Upload source maps for Flutter web applications.

Choose the method that best suits your workflow and platform requirements. For most users, the Sentry Dart Plugin provides the simplest solution across all platforms.
9 changes: 9 additions & 0 deletions docs/platforms/dart/common/debug-symbols/manual-upload.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Manual Upload
description: "Learn how to manually upload debug symbols for your Dart applications."
sidebar_order: 2
---

If you choose not to use the Sentry Dart Plugin, you can manually upload debug symbols for your Dart applications. This page provides instructions for different platforms.

<PlatformContent includePath="debug-symbols/manual-upload" />
File renamed without changes.
11 changes: 11 additions & 0 deletions docs/platforms/dart/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
title: Dart
caseStyle: camelCase
supportLevel: production
sdk: sentry.dart
categories:
- desktop
- mobile
- server
keywords:
- flutter
- dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Sentry Dart Plugin
description: "Learn how to use the Sentry Dart Plugin to automatically upload debug symbols for your Dart application."
sidebar_order: 1
---

The [Sentry Dart Plugin](https://github.com/getsentry/sentry-dart-plugin) is the recommended way to upload debug symbols for Dart applications. It automates the upload process for Android, iOS, macOS, and Web, making it seamless to provide Sentry with the necessary files for symbolication.

<PlatformContent includePath="debug-symbols/dart-plugin" />
37 changes: 37 additions & 0 deletions docs/platforms/dart/guides/flutter/debug-symbols/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Debug Symbols
description: "Learn about uploading debug symbols to enable symbolication of stack traces in your Dart applications."
sidebar_order: 3
---

Debug symbols are essential for understanding stack traces in your Dart application when errors occur. Without debug symbols, stack traces from minified or obfuscated code can be difficult or impossible to interpret.

## What Are Debug Symbols?

Debug symbols provide the necessary information to convert program addresses back to function names, source file names, and line numbers. When you build a Dart application, especially with obfuscation or optimization enabled, this information is typically removed from the main application bundle to reduce size.

In Dart applications, debug symbols can include:

- **For Dart code**: Symbol files generated when using `--split-debug-info` and `--obfuscate` flags
- **For iOS/macOS**: dSYM files
- **For Android**: Proguard/R8 mapping files and symbols files
- **For Flutter Web**: Source maps
- **For Android NDK**: ELF DWARF debug files

## When to Upload Debug Symbols

With default settings, complete stack traces are available in your Dart errors out of the box, unless you use [`split-debug-info`](https://flutter.dev/docs/perf/app-size#reducing-app-size) and [`obfuscate`](https://flutter.dev/docs/deployment/obfuscate) flags. In these cases, you must upload the debug information files generated by the build, so Sentry can show proper stack traces.

## Upload Methods

Sentry offers several methods to upload debug symbols for Dart applications:

1. **[Sentry Dart Plugin (Recommended)](/platforms/dart/guides/flutter/debug-symbols/dart-plugin)** - The easiest way to automatically upload debug symbols for iOS, Android, and Web.

2. **[Manual Upload Options](/platforms/dart/guides/flutter/debug-symbols/manual-upload):**
- [iOS and macOS](/platforms/apple/dsym/) - Upload dSYM files for symbolication of Apple platform crashes.
- [Android](/cli/dif/#uploading-files) - Upload mapping files manually using the Sentry CLI.
- [Android NDK](/cli/dif/#uploading-files) - Upload ELF DWARF debug files for native code crashes.
- [Web](/cli/releases/#upload-source-maps) - Upload source maps for Flutter web applications.

Choose the method that best suits your workflow and platform requirements. For most users, the Sentry Dart Plugin provides the simplest solution across all platforms.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Manual Upload
description: "Learn how to manually upload debug symbols for your Dart applications."
sidebar_order: 2
---

If you choose not to use the Sentry Dart Plugin, you can manually upload debug symbols for your Dart applications. This page provides instructions for different platforms.

<PlatformContent includePath="debug-symbols/manual-upload" />
254 changes: 0 additions & 254 deletions docs/platforms/dart/guides/flutter/upload-debug.mdx

This file was deleted.

Loading
Loading