Godot Engine
Our SDK for Godot Engine builds on top of existing Sentry SDKs, extending them with Godot-specific features. It gives developers helpful hints for where and why an error or performance issue might have occurred.
Features:
- Native support for automatic crash error tracking on Windows, macOS and Linux using the Native SDK to support C and C++ with minidumps
- Enrich events with tags, breadcrumbs, contexts including custom ones
- Capture Godot errors, such as script and shader error
- Adding surrounding script source code if available
- Throttling options for spammy errors
- Filter and customize events in
before_sendandon_crashcallbacks (in GDScript) - Attachment support for Godot logs
- Information about user configuration like GPU, CPU, platform and such
- Configure options in Project Settings and/or in GDScript
On this page, we get you up and running with Sentry's SDK.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Sentry captures data through our addon for Godot Engine which you can install in your project.
Download the latest stable version 0.1.2 from GitHub Releases. The archive includes the Sentry SDK addon and a demo project. You can either extract the entire archive into a separate folder to open the demo in Godot Engine or extract only addons/sentrysdk into existing project.
Ensure that the addon is placed exactly as it is in the demo project, in the addons/sentrysdk folder, preserving the exact casing.
The minimum configuration required is the DSN to your project.
Sentry can be configured via Project Settings or in GDScript. To access project settings in Godot Engine, navigate to Project > Project Settings..., then scroll down the sections list on the left until you find the Sentry section.
Your configuration is saved in the project.godot file along with other project settings.
Add a Node to your test scene and attach a script with the following content:
extends Node
func _ready():
SentrySDK.add_breadcrumb("Just about to welcome the World.", "Note")
SentrySDK.capture_message("Hello, World!")
This snippet includes message capturing, so you can test that everything is working as soon as you set it up.
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").