feat: Structured logging

android_lib/src/main/java/io/sentry/godotplugin/SentryAndroidGodotPlugin.kt

@@ -6,10 +6,12 @@ import io.sentry.Breadcrumb
 import io.sentry.Hint
 import io.sentry.ISerializer
 import io.sentry.Sentry
+import io.sentry.SentryAttributes
 import io.sentry.SentryEvent
 import io.sentry.SentryLevel
 import io.sentry.SentryOptions
 import io.sentry.android.core.SentryAndroid
+import io.sentry.logger.SentryLogParameters
 import io.sentry.protocol.Message
 import io.sentry.protocol.SentryException
 import io.sentry.protocol.SentryStackFrame
@@ -132,6 +134,7 @@ class SentryAndroidGodotPlugin(godot: Godot) : GodotPlugin(godot) {
         environment: String,
         sampleRate: Float,
         maxBreadcrumbs: Int,
+        enableLogs: Boolean
     ) {
         Log.v(TAG, "Initializing Sentry Android")
         SentryAndroid.init(godot.getActivity()!!.applicationContext) { options ->
@@ -144,6 +147,7 @@ class SentryAndroidGodotPlugin(godot: Godot) : GodotPlugin(godot) {
             options.maxBreadcrumbs = maxBreadcrumbs
             options.sdkVersion?.name = "sentry.java.android.godot"
             options.nativeSdkName = "sentry.native.android.godot"
+            options.logs.isEnabled = enableLogs
             options.beforeSend =
                 SentryOptions.BeforeSendCallback { event: SentryEvent, hint: Hint ->
                     Log.v(TAG, "beforeSend: ${event.eventId} isCrashed: ${event.isCrashed}")
@@ -237,6 +241,20 @@ class SentryAndroidGodotPlugin(godot: Godot) : GodotPlugin(godot) {
         Sentry.addBreadcrumb(crumb)
     }
 
+    @UsedByGodot
+    fun log(level: Int, body: String, attributes: Dictionary) {
+        if (attributes.isEmpty()) {
+            Sentry.logger().log(level.toSentryLogLevel(), body)
+        } else {
+            val sentryAttributes = SentryAttributes.fromMap(attributes)
+            Sentry.logger().log(
+                level.toSentryLogLevel(),
+                SentryLogParameters.create(sentryAttributes),
+                body
+            )
+        }
+    }
+
     @UsedByGodot
     fun captureMessage(message: String, level: Int): String {
         val id = Sentry.captureMessage(message, level.toSentryLevel())

android_lib/src/main/java/io/sentry/godotplugin/UtilityFunctions.kt

@@ -1,6 +1,7 @@
 package io.sentry.godotplugin
 
 import io.sentry.SentryLevel
+import io.sentry.SentryLogLevel
 import java.util.Date
 import java.time.Instant
 
@@ -14,6 +15,17 @@ fun Int.toSentryLevel(): SentryLevel =
         else -> SentryLevel.ERROR
     }
 
+fun Int.toSentryLogLevel(): SentryLogLevel =
+    when (this) {
+        0 -> SentryLogLevel.TRACE
+        1 -> SentryLogLevel.DEBUG
+        2 -> SentryLogLevel.INFO
+        3 -> SentryLogLevel.WARN
+        4 -> SentryLogLevel.ERROR
+        5 -> SentryLogLevel.FATAL
+        else -> SentryLogLevel.INFO
+    }
+
 fun SentryLevel.toInt(): Int =
     when (this) {
         SentryLevel.DEBUG -> 0

project/project.godot

@@ -51,3 +51,4 @@ options/dsn="https://[email protected]
 options/attach_scene_tree=true
 logger/include_variables=true
 experimental/attach_screenshot=true
+experimental/enable_logs=true

project/test/suites/test_logger_integration.gd

@@ -17,7 +17,7 @@ func test_gdscript_error_event_structure() -> void:
 
 	assert_json(json).describe("Logger event has logger attribute") \
 		.at("/") \
-		.must_contain("logger", "SentryLogger") \
+		.must_contain("logger", "SentryGodotLogger") \
 		.verify()
 
 	assert_json(json).describe("Logger error event contains exception data") \

project/views/enrich_events.gd

@@ -9,7 +9,12 @@ extends VBoxContainer
 
 
 func _ready() -> void:
-	pass
+	SentrySDK.logger.debug("Starting %s at %d usec", ["SentrySDK", Time.get_ticks_usec()], {
+		"hello": "world!",
+		"meaning.of.life": 42
+	})
+
+	SentrySDK.logger.info("Hello")
 
 
 func _on_add_breadcrumb_button_pressed() -> void:

src/register_types.cpp

@@ -8,6 +8,7 @@
 #include "sentry/sentry_attachment.h"
 #include "sentry/sentry_breadcrumb.h"
 #include "sentry/sentry_event.h"
+#include "sentry/sentry_godot_logger.h"
 #include "sentry/sentry_logger.h"
 #include "sentry/sentry_options.h"
 #include "sentry/sentry_sdk.h"
@@ -48,6 +49,7 @@ void register_runtime_classes() {
 	GDREGISTER_INTERNAL_CLASS(RuntimeConfig);
 	GDREGISTER_CLASS(SentryUser);
 	GDREGISTER_CLASS(SentryTimestamp);
+	GDREGISTER_CLASS(SentryLogger);
 	GDREGISTER_CLASS(SentrySDK);
 	GDREGISTER_ABSTRACT_CLASS(SentryAttachment);
 	GDREGISTER_ABSTRACT_CLASS(SentryEvent);
@@ -56,7 +58,7 @@ void register_runtime_classes() {
 	GDREGISTER_INTERNAL_CLASS(SentryEventProcessor);
 	GDREGISTER_INTERNAL_CLASS(ScreenshotProcessor);
 	GDREGISTER_INTERNAL_CLASS(ViewHierarchyProcessor);
-	GDREGISTER_INTERNAL_CLASS(SentryLogger);
+	GDREGISTER_INTERNAL_CLASS(SentryGodotLogger);
 
 #ifdef SDK_NATIVE
 	GDREGISTER_INTERNAL_CLASS(native::NativeEvent);

src/sentry/android/android_sdk.cpp

@@ -15,6 +15,15 @@
 
 using namespace godot;
 
+namespace {
+
+inline Variant _as_attribute(const Variant &p_value) {
+	Variant::Type type = p_value.get_type();
+	return (type < Variant::BOOL || type > Variant::STRING) ? (Variant)p_value.stringify() : p_value;
+}
+
+} // unnamed namespace
+
 namespace sentry::android {
 
 void SentryAndroidBeforeSendHandler::_initialize(Object *p_android_plugin) {
@@ -92,6 +101,40 @@ void AndroidSDK::add_breadcrumb(const Ref<SentryBreadcrumb> &p_breadcrumb) {
 	android_plugin->call(ANDROID_SN(addBreadcrumb), crumb->get_handle());
 }
 
+void AndroidSDK::log(LogLevel p_level, const String &p_body, const Array &p_params, const Dictionary &p_attributes) {
+	ERR_FAIL_NULL(android_plugin);
+
+	if (p_body.is_empty()) {
+		return;
+	}
+
+	String body = p_body;
+
+	bool has_params = !p_params.is_empty();
+	bool has_attributes = !p_attributes.is_empty();
+
+	Dictionary attributes;
+
+	if (has_params) {
+		attributes["sentry.message.template"] = body;
+		for (int i = 0; i < p_params.size(); i++) {
+			String key = "sentry.message.parameter." + itos(i);
+			attributes[key] = _as_attribute(p_params[i]);
+		}
+		body = body % p_params;
+	}
+
+	if (has_attributes) {
+		const Array &keys = p_attributes.keys();
+		for (int i = 0; i < keys.size(); i++) {
+			const String &key = keys[i];
+			attributes[key] = _as_attribute(p_attributes[key]);
+		}
+	}
+
+	android_plugin->call(ANDROID_SN(log), p_level, body, attributes);
+}
+
 String AndroidSDK::capture_message(const String &p_message, Level p_level) {
 	ERR_FAIL_NULL_V(android_plugin, String());
 	return android_plugin->call(ANDROID_SN(captureMessage), p_message, p_level);
@@ -164,7 +207,8 @@ void AndroidSDK::init(const PackedStringArray &p_global_attachments, const Calla
 			SentryOptions::get_singleton()->get_dist(),
 			SentryOptions::get_singleton()->get_environment(),
 			SentryOptions::get_singleton()->get_sample_rate(),
-			SentryOptions::get_singleton()->get_max_breadcrumbs());
+			SentryOptions::get_singleton()->get_max_breadcrumbs(),
+			SentryOptions::get_singleton()->get_enable_logs());
 
 	if (is_enabled()) {
 		set_user(SentryUser::create_default());

src/sentry/android/android_sdk.h

@@ -41,6 +41,8 @@ class AndroidSDK : public InternalSDK {
 	virtual Ref<SentryBreadcrumb> create_breadcrumb() override;
 	virtual void add_breadcrumb(const Ref<SentryBreadcrumb> &p_breadcrumb) override;
 
+	virtual void log(LogLevel p_level, const String &p_body, const Array &p_params = Array(), const Dictionary &p_attributes = Dictionary()) override;
+
 	virtual String capture_message(const String &p_message, Level p_level = sentry::LEVEL_INFO) override;
 	virtual String get_last_event_id() override;
 

src/sentry/android/android_string_names.cpp

@@ -25,6 +25,7 @@ AndroidStringNames::AndroidStringNames() {
 	setUser = StringName("setUser");
 	removeUser = StringName("removeUser");
 	addBreadcrumb = StringName("addBreadcrumb");
+	log = StringName("log");
 	captureMessage = StringName("captureMessage");
 	getLastEventId = StringName("getLastEventId");
 	captureError = StringName("captureError");

src/sentry/android/android_string_names.h

@@ -37,6 +37,7 @@ class AndroidStringNames {
 	StringName setUser;
 	StringName removeUser;
 	StringName addBreadcrumb;
+	StringName log;
 	StringName captureMessage;
 	StringName getLastEventId;
 	StringName captureError;

src/sentry/cocoa/cocoa_sdk.h

@@ -28,6 +28,8 @@ class CocoaSDK : public InternalSDK {
 	virtual Ref<SentryBreadcrumb> create_breadcrumb() override;
 	virtual void add_breadcrumb(const Ref<SentryBreadcrumb> &p_breadcrumb) override;
 
+	virtual void log(LogLevel p_level, const String &p_body, const Array &p_params = Array(), const Dictionary &p_attributes = Dictionary()) override;
+
 	virtual String capture_message(const String &p_message, Level p_level = sentry::LEVEL_INFO) override;
 	virtual String get_last_event_id() override;
 

src/sentry/cocoa/cocoa_sdk.mm

@@ -18,6 +18,27 @@
 
 using namespace godot;
 
+namespace {
+
+NSObject *_as_attribute(const Variant &p_value) {
+	switch (p_value.get_type()) {
+		case Variant::BOOL: {
+			return [NSNumber numberWithBool:(bool)p_value];
+		} break;
+		case Variant::INT: {
+			return [NSNumber numberWithLongLong:(int64_t)p_value];
+		} break;
+		case Variant::FLOAT: {
+			return [NSNumber numberWithDouble:(double)p_value];
+		} break;
+		default: {
+			return [NSString stringWithUTF8String:p_value.stringify().utf8()];
+		} break;
+	}
+}
+
+} // unnamed namespace
+
 namespace sentry::cocoa {
 
 void CocoaSDK::set_context(const String &p_key, const Dictionary &p_value) {
@@ -79,6 +100,73 @@
 	[objc::SentrySDK addBreadcrumb:crumb->get_cocoa_breadcrumb()];
 }
 
+void CocoaSDK::log(LogLevel p_level, const String &p_body, const Array &p_params, const Dictionary &p_attributes) {
+	if (p_body.is_empty()) {
+		return;
+	}
+
+	String body = p_body;
+
+	NSMutableDictionary *attributes = nil;
+	bool has_params = !p_params.is_empty();
+	bool has_attributes = !p_attributes.is_empty();
+
+	if (has_params || has_attributes) {
+		attributes = [[NSMutableDictionary alloc] initWithCapacity:p_params.size() + p_attributes.size() + 1];
+
+		if (has_params) {
+			[attributes setObject:string_to_objc(body) forKey:@"sentry.message.template"];
+			for (int i = 0; i < p_params.size(); i++) {
+				NSString *objc_key = [NSString stringWithFormat:@"sentry.message.parameter.%d", i];
+				NSObject *objc_value = _as_attribute(p_params[i]);
+				[attributes setObject:objc_value forKey:objc_key];
+			}
+			body = body % p_params;
+		}
+
+		if (has_attributes) {
+			const Array &keys = p_attributes.keys();
+			for (int i = 0; i < keys.size(); i++) {
+				const String &key = keys[i];
+				const NSString *objc_key = [NSString stringWithUTF8String:key.utf8()];
+				const NSObject *objc_value = _as_attribute(p_attributes[key]);
+				[attributes setObject:objc_value forKey:objc_key];
+			}
+		}
+	}
+
+	switch (p_level) {
+		case LOG_LEVEL_TRACE: {
+			[[objc::SentrySDK logger] trace:string_to_objc(body)
+								 attributes:attributes];
+		} break;
+		case LOG_LEVEL_DEBUG: {
+			[[objc::SentrySDK logger] debug:string_to_objc(body)
+								 attributes:attributes];
+		} break;
+		case LOG_LEVEL_INFO: {
+			[[objc::SentrySDK logger] info:string_to_objc(body)
+								attributes:attributes];
+		} break;
+		case LOG_LEVEL_WARN: {
+			[[objc::SentrySDK logger] warn:string_to_objc(body)
+								attributes:attributes];
+		} break;
+		case LOG_LEVEL_ERROR: {
+			[[objc::SentrySDK logger] error:string_to_objc(body)
+								 attributes:attributes];
+		} break;
+		case LOG_LEVEL_FATAL: {
+			[[objc::SentrySDK logger] fatal:string_to_objc(body)
+								 attributes:attributes];
+		} break;
+		default: {
+			[[objc::SentrySDK logger] debug:string_to_objc(body)
+								 attributes:attributes];
+		} break;
+	}
+}
+
 String CocoaSDK::capture_message(const String &p_message, Level p_level) {
 	objc::SentryId *event_id = [objc::SentrySDK captureMessage:string_to_objc(p_message)
 												withScopeBlock:^(objc::SentryScope *scope) {
@@ -166,6 +254,8 @@
 		// NOTE: This only works for captureMessage(), unfortunately.
 		options.attachStacktrace = false;
 
+		options.experimental.enableLogs = SentryOptions::get_singleton()->get_enable_logs();
+
 		options.initialScope = ^(objc::SentryScope *scope) {
 			// Add global attachments
 			for (const String &path : p_global_attachments) {

src/sentry/disabled/disabled_sdk.h

@@ -21,6 +21,8 @@ class DisabledSDK : public InternalSDK {
 	virtual Ref<SentryBreadcrumb> create_breadcrumb() override { return memnew(DisabledBreadcrumb); }
 	virtual void add_breadcrumb(const Ref<SentryBreadcrumb> &p_breadcrumb) override {}
 
+	virtual void log(LogLevel p_level, const String &p_body, const Array &p_params = Array(), const Dictionary &p_attributes = Dictionary()) override {}
+
 	virtual String capture_message(const String &p_message, Level p_level = sentry::LEVEL_INFO) override { return ""; }
 	virtual String get_last_event_id() override { return ""; }
 

src/sentry/internal_sdk.h

@@ -2,6 +2,7 @@
 #define INTERNAL_SDK_H
 
 #include "sentry/level.h"
+#include "sentry/log_level.h"
 #include "sentry/sentry_attachment.h"
 #include "sentry/sentry_breadcrumb.h"
 #include "sentry/sentry_event.h"
@@ -31,6 +32,8 @@ class InternalSDK {
 	// TODO: Consider adding the following function.
 	// virtual void clear_breadcrumbs() = 0;
 
+	virtual void log(LogLevel p_level, const String &p_body, const Array &p_params = Array(), const Dictionary &p_attributes = Dictionary()) = 0;
+
 	virtual String capture_message(const String &p_message, Level p_level) = 0;
 	virtual String get_last_event_id() = 0;
 

src/sentry/log_level.h

@@ -0,0 +1,14 @@
+#pragma once
+
+namespace sentry {
+
+enum LogLevel {
+	LOG_LEVEL_TRACE,
+	LOG_LEVEL_DEBUG,
+	LOG_LEVEL_INFO,
+	LOG_LEVEL_WARN,
+	LOG_LEVEL_ERROR,
+	LOG_LEVEL_FATAL
+};
+
+}