feat: Add environment property to SentryOptions (#66)

Add SentryOptions.environment property. Environment is auto-detected for user convenience, and it will be possible to assign it after #60 is merged.

Also, change auto-detected environment names to prioritize development environments.

Resolves GH-64

Author: limbonaut

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Improve & expose `SentryOptions` class ([#56](https://github.com/getsentry/sentry-godot/pull/56))
 - Create or modify events using `SentryEvent` objects and new SDK methods: `SentrySDK.create_event()`, `SentrySDK.capture_event(event)` ([#51](https://github.com/getsentry/sentry-godot/pull/51))
+- New `environment` property in `SentryOptions` and better auto-naming to prioritize development environments ([#66](https://github.com/getsentry/sentry-godot/pull/66))
 - Configure the SDK via GDScript and filter events using event hooks `before_send` and `on_crash`. The new `SentryConfiguration` class can be extended in a script and assigned in options to configure the SDK during initialization. However, due to the way scripting is initialized in the Godot Engine, this comes with a trade-off: a slightly later initialization. If a configuration script is assigned, initialization must be delayed until ScriptServer is ready to load and run the user script. ([#60](https://github.com/getsentry/sentry-godot/pull/60))
 
 ### Dependencies

project/example_configuration.gd

@@ -10,6 +10,7 @@ func _configure(options: SentryOptions) -> void:
 
 	options.debug = true
 	options.release = "sentry-godot-demo@" + ProjectSettings.get_setting("application/config/version")
+	options.environment = "demo"
 
 	# Set up event callbacks
 	options.before_send = _before_send

src/sentry/contexts.cpp

@@ -268,7 +268,7 @@ Dictionary make_godot_engine_context() {
 	godot_context["version_commit"] = version_info.get("hash", "");
 	godot_context["debug_build"] = OS::get_singleton()->is_debug_build();
 	godot_context["command_line_arguments"] = OS::get_singleton()->get_cmdline_args();
-	godot_context["mode"] = String(sentry::environment::get_environment());
+	godot_context["mode"] = sentry::environment::detect_godot_environment();
 	godot_context["editor_build"] = OS::get_singleton()->has_feature("editor");
 	godot_context["godot_sdk_version"] = String(SENTRY_GODOT_SDK_VERSION);
 

src/sentry/environment.cpp

@@ -5,20 +5,22 @@
 
 namespace sentry::environment {
 
-CharString get_environment() {
+String detect_godot_environment() {
 	ERR_FAIL_NULL_V(Engine::get_singleton(), "production");
 	ERR_FAIL_NULL_V(OS::get_singleton(), "production");
 
+	// We need to have either "dev" or "debug" in the name to prioritize dev environments:
+	// https://develop.sentry.dev/application-architecture/dynamic-sampling/fidelity-and-biases/#prioritize-dev-environments
 	if (OS::get_singleton()->has_feature("dedicated_server")) {
 		return "dedicated_server";
 	} else if (Engine::get_singleton()->is_editor_hint()) {
-		return "editor";
+		return "editor_dev";
 	} else if (OS::get_singleton()->has_feature("editor")) {
-		return "editor-run";
+		return "editor_dev_run";
 	} else if (OS::get_singleton()->is_debug_build()) {
-		return "export-debug";
+		return "export_debug";
 	} else {
-		return "export-release";
+		return "export_release";
 	}
 }
 

src/sentry/environment.h

@@ -4,6 +4,6 @@ using namespace godot;
 
 namespace sentry::environment {
 
-CharString get_environment();
+String detect_godot_environment();
 
 }

src/sentry/native/native_sdk.cpp

@@ -2,7 +2,6 @@
 
 #include "sentry.h"
 #include "sentry/contexts.h"
-#include "sentry/environment.h"
 #include "sentry/level.h"
 #include "sentry/native/native_event.h"
 #include "sentry/native/native_util.h"
@@ -219,7 +218,16 @@ void NativeSDK::initialize() {
 	ERR_FAIL_NULL(ProjectSettings::get_singleton());
 
 	sentry_options_t *options = sentry_options_new();
+
 	sentry_options_set_dsn(options, SentryOptions::get_singleton()->get_dsn().utf8());
+	sentry_options_set_database_path(options, (OS::get_singleton()->get_user_data_dir() + "/sentry").utf8());
+	sentry_options_set_debug(options, SentryOptions::get_singleton()->is_debug_enabled());
+	sentry_options_set_release(options, SentryOptions::get_singleton()->get_release().utf8());
+	sentry_options_set_environment(options, SentryOptions::get_singleton()->get_environment().utf8());
+	// TODO: add dist
+	sentry_options_set_sample_rate(options, SentryOptions::get_singleton()->get_sample_rate());
+	sentry_options_set_max_breadcrumbs(options, SentryOptions::get_singleton()->get_max_breadcrumbs());
+	sentry_options_set_sdk_name(options, "sentry.native.godot");
 
 	// Establish handler path.
 	String handler_fn;
@@ -247,14 +255,6 @@ void NativeSDK::initialize() {
 		sentry_options_set_backend(options, NULL);
 	}
 
-	sentry_options_set_database_path(options, (OS::get_singleton()->get_user_data_dir() + "/sentry").utf8());
-	sentry_options_set_sample_rate(options, SentryOptions::get_singleton()->get_sample_rate());
-	sentry_options_set_release(options, SentryOptions::get_singleton()->get_release().utf8());
-	sentry_options_set_debug(options, SentryOptions::get_singleton()->is_debug_enabled());
-	sentry_options_set_environment(options, sentry::environment::get_environment());
-	sentry_options_set_sdk_name(options, "sentry.native.godot");
-	sentry_options_set_max_breadcrumbs(options, SentryOptions::get_singleton()->get_max_breadcrumbs());
-
 	// Attach LOG file.
 	// TODO: Decide whether log-file must be trimmed before send.
 	if (SentryOptions::get_singleton()->is_attach_log_enabled()) {

src/sentry_options.cpp

@@ -1,4 +1,6 @@
 #include "sentry_options.h"
+
+#include "sentry/environment.h"
 #include "sentry/simple_bind.h"
 
 #include <godot_cpp/classes/project_settings.hpp>
@@ -135,6 +137,7 @@ void SentryOptions::_bind_methods() {
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "disabled_in_editor"), set_disabled_in_editor, is_disabled_in_editor);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::STRING, "dsn"), set_dsn, get_dsn);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::STRING, "release"), set_release, get_release);
+	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::STRING, "environment"), set_environment, get_environment);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "debug"), set_debug_enabled, is_debug_enabled);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::FLOAT, "sample_rate"), set_sample_rate, get_sample_rate);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "attach_log"), set_attach_log, is_attach_log_enabled);
@@ -163,6 +166,7 @@ void SentryOptions::_bind_methods() {
 
 SentryOptions::SentryOptions() {
 	error_logger_limits.instantiate(); // Ensure limits are initialized.
+	environment = sentry::environment::detect_godot_environment();
 }
 
 SentryOptions::~SentryOptions() {

src/sentry_options.h

@@ -44,6 +44,7 @@ class SentryOptions : public RefCounted {
 	bool disabled_in_editor = true;
 	String dsn = "";
 	String release = "{app_name}@{app_version}";
+	String environment;
 	bool debug = false;
 	double sample_rate = 1.0;
 	bool attach_log = true;
@@ -83,6 +84,9 @@ class SentryOptions : public RefCounted {
 	_FORCE_INLINE_ String get_release() const { return release; }
 	_FORCE_INLINE_ void set_release(const String &p_release) { release = p_release; }
 
+	_FORCE_INLINE_ String get_environment() const { return environment; }
+	_FORCE_INLINE_ void set_environment(const String &p_environment) { environment = p_environment; }
+
 	_FORCE_INLINE_ bool is_debug_enabled() const { return debug; }
 	_FORCE_INLINE_ void set_debug_enabled(bool p_debug) { debug = p_debug; }