diff --git a/CHANGELOG.md b/CHANGELOG.md index 36cd328005..8ed4a1ad66 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,10 @@ - Add `sentry_get_last_event_id` and `sentry_scope_get_last_event_id` for retrieving the last event ID captured with the global or given scope, respectively. ([#1992](https://github.com/getsentry/sentry-native/pull/1992)) - Native/Unix: The native crash daemon now loads `libcurl` dynamically at runtime by default when `SENTRY_LINK_CURL=AUTO`, avoiding `libcurl` linker work during process startup and significantly speeding up startup time. Explicitly set `SENTRY_LINK_CURL=ON` to link it directly. ([#1955](https://github.com/getsentry/sentry-native/pull/1955)) +**Deprecations**: + +- Deprecate `sentry_options_get/set_enable_logs` and `sentry_options_get/set_enable_metrics`. ([#2000](https://github.com/getsentry/sentry-native/pull/2000)) + **Fixes**: - Native: store daemon logs, minidumps, crash envelopes, and scratch files in `.run` directories so they are cleaned up with the run instead of accumulating in the database root. Minidumps can still be retained with `cache_keep`, which stores `.dmp` sidecars alongside cached envelopes. ([#1976](https://github.com/getsentry/sentry-native/pull/1976)) diff --git a/examples/example.c b/examples/example.c index 005a8f36dd..0770d7cb19 100644 --- a/examples/example.c +++ b/examples/example.c @@ -857,9 +857,11 @@ main(int argc, char **argv) sentry_options_set_logger_enabled_when_crashed(options, 1); } + SENTRY_SUPPRESS_DEPRECATED if (has_arg(argc, argv, "disable-logs")) { sentry_options_set_enable_logs(options, false); } + SENTRY_RESTORE_DEPRECATED if (has_arg(argc, argv, "crash-reporter")) { #ifdef SENTRY_PLATFORM_WINDOWS @@ -895,9 +897,11 @@ main(int argc, char **argv) sentry_options_set_http_retry(options, false); } + SENTRY_SUPPRESS_DEPRECATED if (has_arg(argc, argv, "disable-metrics")) { sentry_options_set_enable_metrics(options, false); } + SENTRY_RESTORE_DEPRECATED if (has_arg(argc, argv, "before-send-metric")) { sentry_options_set_before_send_metric( @@ -1062,6 +1066,7 @@ main(int argc, char **argv) } } + SENTRY_SUPPRESS_DEPRECATED if (sentry_options_get_enable_logs(options)) { if (has_arg(argc, argv, "capture-log")) { sentry_log_debug("I'm a log message!"); @@ -1111,6 +1116,7 @@ main(int argc, char **argv) run_threads(metric_thread_func); } } + SENTRY_RESTORE_DEPRECATED if (!has_arg(argc, argv, "no-setup")) { sentry_set_transaction("test-transaction"); diff --git a/include/sentry.h b/include/sentry.h index 35da3abcd7..4eef281640 100644 --- a/include/sentry.h +++ b/include/sentry.h @@ -2620,8 +2620,10 @@ SENTRY_EXPERIMENTAL_API int sentry_options_get_strict_trace_continuation( * * Enabled by default. */ +SENTRY_DEPRECATED("This function will be removed in a future release.") SENTRY_EXPERIMENTAL_API void sentry_options_set_enable_logs( sentry_options_t *opts, int enable_logs); +SENTRY_DEPRECATED("This function will be removed in a future release.") SENTRY_EXPERIMENTAL_API int sentry_options_get_enable_logs( const sentry_options_t *opts); @@ -2804,8 +2806,10 @@ SENTRY_EXPERIMENTAL_API void sentry_options_set_before_send_log( * * Enabled by default. */ +SENTRY_DEPRECATED("This function will be removed in a future release.") SENTRY_EXPERIMENTAL_API void sentry_options_set_enable_metrics( sentry_options_t *opts, int enable_metrics); +SENTRY_DEPRECATED("This function will be removed in a future release.") SENTRY_EXPERIMENTAL_API int sentry_options_get_enable_metrics( const sentry_options_t *opts); diff --git a/ndk/lib/src/main/jni/sentry.c b/ndk/lib/src/main/jni/sentry.c index 36516b9c8e..30ecb6d55f 100644 --- a/ndk/lib/src/main/jni/sentry.c +++ b/ndk/lib/src/main/jni/sentry.c @@ -527,7 +527,9 @@ Java_io_sentry_ndk_SentryNdk_initSentryNative( jboolean enable_logs = (jboolean)(*env)->CallBooleanMethod( env, sentry_ndk_options, enable_logs_mid); + SENTRY_SUPPRESS_DEPRECATED sentry_options_set_enable_logs(options, enable_logs); + SENTRY_RESTORE_DEPRECATED int rv = sentry_init(options); return (jint)rv; diff --git a/tests/unit/test_logger.c b/tests/unit/test_logger.c index 44360a1268..b81813bdd8 100644 --- a/tests/unit/test_logger.c +++ b/tests/unit/test_logger.c @@ -39,8 +39,9 @@ SENTRY_TEST(custom_logger) SENTRY_TEST_OPTIONS_NEW(options); sentry_options_set_debug(options, true); sentry_options_set_logger(options, test_logger, &data); - sentry_options_set_enable_metrics(options, false); - sentry_options_set_enable_logs(options, false); + SENTRY_TEST_DEPRECATED( + sentry_options_set_enable_metrics(options, false)); + SENTRY_TEST_DEPRECATED(sentry_options_set_enable_logs(options, false)); sentry_init(options); @@ -68,8 +69,8 @@ SENTRY_TEST(logger_enable_disable_functionality) SENTRY_TEST_OPTIONS_NEW(options); sentry_options_set_debug(options, true); sentry_options_set_logger(options, test_logger, &data); - sentry_options_set_enable_metrics(options, false); - sentry_options_set_enable_logs(options, false); + SENTRY_TEST_DEPRECATED(sentry_options_set_enable_metrics(options, false)); + SENTRY_TEST_DEPRECATED(sentry_options_set_enable_logs(options, false)); sentry_init(options); @@ -139,8 +140,10 @@ SENTRY_TEST(logger_level) sentry_options_set_debug(options, true); sentry_options_set_logger_level(options, test_cases[i].level); sentry_options_set_logger(options, test_log_level, &data); - sentry_options_set_enable_metrics(options, false); - sentry_options_set_enable_logs(options, false); + SENTRY_TEST_DEPRECATED( + sentry_options_set_enable_metrics(options, false)); + SENTRY_TEST_DEPRECATED( + sentry_options_set_enable_logs(options, false)); sentry_init(options); diff --git a/tests/unit/test_logs.c b/tests/unit/test_logs.c index 1e7cfcb945..0c122bffce 100644 --- a/tests/unit/test_logs.c +++ b/tests/unit/test_logs.c @@ -81,7 +81,7 @@ SENTRY_TEST(logs_disabled) SENTRY_TEST_OPTIONS_NEW(options); sentry_options_set_dsn(options, "https://foo@sentry.invalid/42"); - sentry_options_set_enable_logs(options, false); + SENTRY_TEST_DEPRECATED(sentry_options_set_enable_logs(options, false)); sentry_transport_t *transport = sentry_transport_new(validate_logs_envelope); @@ -560,7 +560,7 @@ SENTRY_TEST(logs_plain_string_disabled) { SENTRY_TEST_OPTIONS_NEW(options); sentry_options_set_dsn(options, "https://foo@sentry.invalid/42"); - sentry_options_set_enable_logs(options, false); + SENTRY_TEST_DEPRECATED(sentry_options_set_enable_logs(options, false)); sentry_init(options); diff --git a/tests/unit/test_metrics.c b/tests/unit/test_metrics.c index 7115d07348..2cd625c4a1 100644 --- a/tests/unit/test_metrics.c +++ b/tests/unit/test_metrics.c @@ -268,7 +268,7 @@ SENTRY_TEST(metrics_disabled) SENTRY_TEST_OPTIONS_NEW(options); sentry_options_set_dsn(options, "https://foo@sentry.invalid/42"); - sentry_options_set_enable_metrics(options, false); + SENTRY_TEST_DEPRECATED(sentry_options_set_enable_metrics(options, false)); sentry_transport_t *transport = sentry_transport_new(validate_metrics_envelope); @@ -591,7 +591,7 @@ SENTRY_TEST(metrics_reinit) // This will deadlock if sentry__batcher_flush holds g_options_lock. SENTRY_TEST_OPTIONS_NEW(options2); sentry_options_set_dsn(options2, "https://foo@sentry.invalid/42"); - sentry_options_set_enable_metrics(options2, true); + SENTRY_TEST_DEPRECATED(sentry_options_set_enable_metrics(options2, true)); sentry_init(options2); sentry_close();