Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-garcia authored Mar 8, 2025
1 parent 1dfbc6d commit 631cd26
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/platforms/godot/configuration/stack-traces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Readable Stack Traces
description: "Learn how to get traces with line numbers and file paths in Sentry with SDK for Godot Engine."
---

Debug information files allow Sentry to extract stack traces and provide additional information from crash reports. In order to get stack traces that contain function names, line numbers and file paths, Sentry needs to have these debug information files available when processing crash dumps. For that, you need to export your Godot project using an export template that contains debug information. The official Godot Engine builds only provide templates without debug symbols. This guide covers how to create such templates and use them to export your project with full debug information available in Sentry.
[The official Godot Engine builds only provide templates without debug information files](https://github.com/godotengine/godot-proposals/issues/1342). This guide covers how to create such templates and use them to export your project with full debug information available in Sentry.

Debug information files allow Sentry to extract stack traces and provide additional information from crash reports. In order to get stack traces that contain function names, line numbers and file paths, Sentry needs to have these debug information files available when processing the crash dumps. For that, you need to export your Godot project using an export template that contains debug information.

## Prerequisites

Expand Down Expand Up @@ -47,11 +49,11 @@ For more information, refer to [Building from Source](https://docs.godotengine.o

## Getting Godot Source

Start in a terminal with Git available. Clone Godot Engine repository and switch to your preferred version tag (or branch):
Start in a terminal with Git available. Clone Godot Engine repository and switch to your [preferred version tag](https://github.com/godotengine/godot/releases) (or branch):
```bash
git clone https://github.com/godotengine/godot
cd godot
git checkout 4.3-stable
git checkout 4.4-stable
```

## Compiling Templates
Expand Down Expand Up @@ -98,13 +100,13 @@ You should now be able to export your project using this template. Just make sur

<Alert>

If you need to `Export with Debug`, you can compile a debug template using the `target=template_debug` option. Debug templates enable debugging features in your export, such as breakpoints and debugger support.
If you need to `Export with Debug`, you can compile a debug template using the `target=template_debug` option. Debug templates enable debugging features in your export, such as breakpoints and debugger support but perform slower than a release build, therefore these are not advised when shipping the game for end users.

</Alert>

## Uploading Debug Symbols

In order to get readable stack traces in Sentry, you also need to upload your debug symbols. The easiest way to do it is by using Sentry CLI tools. These tools allow you to upload the necessary debug information, making the stack traces useful for debugging.
In order to get readable stack traces in Sentry, you also need to upload your debug symbols. The easiest way to do it is by using [Sentry CLI](https://docs.sentry.io/cli/). This tool allows you to upload the necessary debug information, making the stack traces useful for debugging.

<Expandable title="Installing Sentry CLI">

Expand Down

0 comments on commit 631cd26

Please sign in to comment.