Skip to content

Commit a60e145

Browse files
authored
docs(Godot): Add docs for missing options (#14907)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR Document logger_messages_as_breadcrumbs option, according to changes in: - getsentry/sentry-godot#305 and also some other options that we're missing in the docs. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [x] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
1 parent 8287f8f commit a60e145

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

docs/platforms/godot/configuration/options.mdx

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can control the verbosity using the `diagnostic_level` option.
3030

3131
</ConfigKey>
3232

33-
<ConfigKey name="diagnostic_level">
33+
<ConfigKey name="diagnostic-level">
3434

3535
Specifies the minimum level of messages to be printed if `debug` is turned on.
3636

@@ -102,6 +102,18 @@ If enabled, the SDK will try to take a screenshot and attach it to the event.
102102

103103
</ConfigKey>
104104

105+
<ConfigKey name="screenshot-level">
106+
107+
Specifies the minimum level of events for which screenshots will be captured. By default, screenshots are captured for fatal events.
108+
109+
<Alert title="Note">
110+
111+
Changing this option may impact performance in the frames the screenshots are taken.
112+
113+
</Alert>
114+
115+
</ConfigKey>
116+
105117
<ConfigKey name="attach-scene-tree">
106118

107119
If enabled, the SDK will capture and attach scene tree information to events. The scene tree data is attached as a `view-hierarchy.json` file, and you can explore it in the "Scene Tree" section of each issue that includes this attachment. This provides valuable context about your game's scene tree at the time of the error. See <PlatformLink to="/enriching-events/view-hierarchy/">Scene Tree</PlatformLink> for more details.
@@ -151,6 +163,24 @@ If `true`, the SDK will include the surrounding source code of logged errors, if
151163

152164
</ConfigKey>
153165

166+
<ConfigKey name="logger-include-variables">
167+
168+
If `true`, the SDK will include local variables from stack traces when capturing script errors. This allows showing the values of variables at each frame in the call stack. Requires enabling **Debug -> Settings -> GDScript -> Always Track Local Variables** in the **Project Settings**.
169+
170+
<Alert title="Note">
171+
172+
Enabling this option may impact performance, especially for applications with frequent errors or deep call stacks.
173+
174+
</Alert>
175+
176+
</ConfigKey>
177+
178+
<ConfigKey name="logger-messages-as-breadcrumbs">
179+
180+
If `true`, the SDK will capture log messages (such as `print()` statements) as breadcrumbs along with events.
181+
182+
</ConfigKey>
183+
154184
<ConfigKey name="logger-limits">
155185

156186
Defines throttling limits for the error logger. These limits are used to prevent the SDK from sending too many non-critical and repeating error events.

0 commit comments

Comments
 (0)