Skip to content

ref(options): Group Godot logger options under options.godot_logger#759

Open
limbonaut wants to merge 12 commits into
mainfrom
ref/godot-logger-renames
Open

ref(options): Group Godot logger options under options.godot_logger#759
limbonaut wants to merge 12 commits into
mainfrom
ref/godot-logger-renames

Conversation

@limbonaut

@limbonaut limbonaut commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

This PR groups the flat logger_* options into a new godot_logger options object on SentryOptions. These options configure the SDK's integration with Godot's logging system, which captures engine errors, script errors, and printed messages as Sentry events, breadcrumbs, and logs. The new structure follows how other Sentry SDKs group feature-specific options (for example, the Logs and Metrics option groups in sentry-java), shortens the option names, and removes the ambiguity between this integration and SentrySDK.logger, Sentry's structured-logging API.

For reviewers

  • The old flat logger_* properties remain as deprecated aliases that proxy to the new object and warn on use, following the same pattern as the earlier app hang renames. Removal is scheduled with the other deprecations (January 2027 or version 3.0).
  • Two deliberate naming decisions: include_source became include_source_context (matches the Python SDK option), and GodotLoggerEventMask with its MASK_* constants intentionally stays on SentryOptions (namespace level in C#) so that future options outside the logger group can reference it.
  • Project settings moved to sentry/godot_logger/*, with a schema v3 migration that renames persisted settings automatically; the demo project's settings are migrated as part of this PR.
  • The C# layer mirrors the new structure as a clean break without [Obsolete] shims, since it has never been released as stable.

@limbonaut limbonaut force-pushed the ref/app-hang-renames branch from 8dce517 to 7df1919 Compare June 15, 2026 10:29
@limbonaut limbonaut force-pushed the ref/godot-logger-renames branch from 2dd8a9f to 087f3b5 Compare June 15, 2026 16:49
Base automatically changed from ref/app-hang-renames to main June 16, 2026 09:41
@limbonaut limbonaut force-pushed the ref/godot-logger-renames branch from 087f3b5 to 77596f8 Compare June 16, 2026 09:53
@limbonaut limbonaut marked this pull request as ready for review June 16, 2026 10:05

@JoshuaMoelans JoshuaMoelans left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just two small fixes

Comment thread src/sentry/sentry_options.cpp Outdated

void SentryOptions::set_logger_messages_as_breadcrumbs(bool p_enabled) {
void SentryOptions::deprecated_set_logger_messages_as_breadcrumbs(bool p_enabled) {
WARN_DEPRECATED_MSG("The \"logger_messages_as_breadcrumbs\" option is deprecated. Set the MASK_MESSAGE flag in \"logger_breadcrumb_mask\" instead.");

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logger_breadcrumb_mask is also deprecated

Suggested change
WARN_DEPRECATED_MSG("The \"logger_messages_as_breadcrumbs\" option is deprecated. Set the MASK_MESSAGE flag in \"logger_breadcrumb_mask\" instead.");
WARN_DEPRECATED_MSG("The \"logger_messages_as_breadcrumbs\" option is deprecated. Set the MASK_MESSAGE flag in \"godot_logger.breadcrumb_mask\" instead.");

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, thanks!

Comment thread src/sentry/settings_migrations.cpp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Group Godot logger options under options.godot_logger

2 participants