feat(logs): add sentry log API + send first logs

examples/example.c

@@ -16,6 +16,8 @@
 #    undef NDEBUG
 #endif
 
+#include "../src/sentry_options.h"
+
 #include <assert.h>
 
 #ifdef SENTRY_PLATFORM_WINDOWS
@@ -359,6 +361,30 @@ main(int argc, char **argv)
 
     sentry_init(options);
 
+    // TODO incorporate into test
+    if (options->enable_logs) {
+        sentry_logger_trace(
+            "We log it up  %i percent, %s style\n", 100, "trace");
+        // sentry_logger_debug(
+        //     "We log it up  %i percent, %s style\n", 100, "debug");
+        // sentry_logger_info("We log it up  %i percent, %s style\n", 100,
+        // "info"); sentry_logger_warn("We log it up  %i percent, %s style\n",
+        // 100, "warn"); sentry_logger_error(
+        //     "We log it up  %i percent, %s style\n", 100, "error");
+        // sentry_logger_fatal(
+        //     "We log it up  %i percent, %s style\n", 100, "fatal");
+
+        // Test the logger with various parameter types
+        sentry_logger_info(
+            "API call to %s completed in %d ms with %f success rate",
+            "/api/products", 2500, 0.95);
+
+        sentry_logger_warn("Processing %d items, found %u errors, pointer: %p",
+            100, 5u, (void *)0x12345678);
+
+        sentry_logger_error("Character '%c' is invalid", 'X');
+    }
+
     if (!has_arg(argc, argv, "no-setup")) {
         sentry_set_transaction("test-transaction");
         sentry_set_level(SENTRY_LEVEL_WARNING);
@@ -566,6 +592,9 @@ main(int argc, char **argv)
                 SENTRY_LEVEL_INFO, "my-logger", "Hello World!");
             sentry_capture_event(event);
         }
+        if (options->enable_logs) {
+            sentry_logger_debug("logging after scoped transaction event");
+        }
 
         sentry_transaction_finish(tx);
     }

include/sentry.h

@@ -1750,6 +1750,14 @@ SENTRY_EXPERIMENTAL_API void sentry_options_set_enable_logs(
 SENTRY_EXPERIMENTAL_API int sentry_options_get_enable_logs(
     const sentry_options_t *opts);
 
+// TODO think about API; functions or MACROs?
+SENTRY_EXPERIMENTAL_API void sentry_logger_trace(const char *message, ...);
+SENTRY_EXPERIMENTAL_API void sentry_logger_debug(const char *message, ...);
+SENTRY_EXPERIMENTAL_API void sentry_logger_info(const char *message, ...);
+SENTRY_EXPERIMENTAL_API void sentry_logger_warn(const char *message, ...);
+SENTRY_EXPERIMENTAL_API void sentry_logger_error(const char *message, ...);
+SENTRY_EXPERIMENTAL_API void sentry_logger_fatal(const char *message, ...);
+
 #ifdef SENTRY_PLATFORM_LINUX
 
 /**

src/CMakeLists.txt

@@ -51,6 +51,8 @@ sentry_target_sources_cwd(sentry
 	transports/sentry_disk_transport.h
 	transports/sentry_function_transport.c
 	unwinder/sentry_unwinder.c
+	sentry_logs.c
+	sentry_logs.h
 )
 
 # generic platform / path / symbolizer

src/sentry_envelope.c

@@ -295,6 +295,32 @@ sentry__envelope_add_transaction(
     return item;
 }
 
+sentry_envelope_item_t *
+sentry__envelope_add_logs(sentry_envelope_t *envelope, sentry_value_t logs)
+{
+    sentry_envelope_item_t *item = envelope_add_item(envelope);
+    if (!item) {
+        return NULL;
+    }
+
+    sentry_jsonwriter_t *jw = sentry__jsonwriter_new_sb(NULL);
+    if (!jw) {
+        return NULL;
+    }
+
+    sentry__jsonwriter_write_value(jw, logs);
+    item->payload = sentry__jsonwriter_into_string(jw, &item->payload_len);
+
+    sentry__envelope_item_set_header(
+        item, "type", sentry_value_new_string("log"));
+    sentry__envelope_item_set_header(item, "item_count",
+        sentry_value_new_int32(sentry_value_get_length(logs)));
+    sentry__envelope_item_set_header(item, "content_type",
+        sentry_value_new_string("application/vnd.sentry.items.log+json"));
+
+    return item;
+}
+
 sentry_envelope_item_t *
 sentry__envelope_add_user_feedback(
     sentry_envelope_t *envelope, sentry_value_t user_feedback)

src/sentry_envelope.h

@@ -42,6 +42,12 @@ sentry_envelope_item_t *sentry__envelope_add_event(
 sentry_envelope_item_t *sentry__envelope_add_transaction(
     sentry_envelope_t *envelope, sentry_value_t transaction);
 
+/**
+ * Add a list of logs to this envelope.
+ */
+sentry_envelope_item_t *sentry__envelope_add_logs(
+    sentry_envelope_t *envelope, sentry_value_t logs);
+
 /**
  * Add a user feedback to this envelope.
  */