- Added default logname key logging.googleapis.com/logName

- Added support for `autoformat_stackdriver_trace` to format the trace as `projects/[PROJECT-ID]/traces/[TRACE-ID]` when enabled

Author: tpetrov-lp

plugins/out_stackdriver/stackdriver.c

@@ -1298,6 +1298,8 @@ static int stackdriver_format(struct flb_config *config,
     /* Parameters for trace */
     int trace_extracted = FLB_FALSE;
     flb_sds_t trace;
+    char stackdriver_trace[PATH_MAX];
+    const char *new_trace;
 
     /* Parameters for log name */
     int log_name_extracted = FLB_FALSE;
@@ -1716,9 +1718,18 @@ static int stackdriver_format(struct flb_config *config,
             msgpack_pack_str(&mp_pck, 5);
             msgpack_pack_str_body(&mp_pck, "trace", 5);
 
-            len = flb_sds_len(trace);
+            if (ctx->autoformat_stackdriver_trace) {
+                len = snprintf(stackdriver_trace, sizeof(stackdriver_trace) - 1,
+                    "projects/%s/traces/%s", ctx->project_id, trace);
+                new_trace = stackdriver_trace;
+            }
+            else {
+                len = flb_sds_len(trace);
+                new_trace = trace;
+            }
+
             msgpack_pack_str(&mp_pck, len);
-            msgpack_pack_str_body(&mp_pck, trace, len);
+            msgpack_pack_str_body(&mp_pck, new_trace, len);
             flb_sds_destroy(trace); 
         }               
 

plugins/out_stackdriver/stackdriver.h

@@ -52,6 +52,7 @@
 #define DEFAULT_LABELS_KEY "logging.googleapis.com/labels"
 #define DEFAULT_SEVERITY_KEY "logging.googleapis.com/severity"
 #define DEFAULT_TRACE_KEY "logging.googleapis.com/trace"
+#define DEFAULT_LOG_NAME_KEY "logging.googleapis.com/logName"
 #define DEFAULT_INSERT_ID_KEY "logging.googleapis.com/insertId"
 #define SOURCELOCATION_FIELD_IN_JSON "logging.googleapis.com/sourceLocation"
 #define HTTPREQUEST_FIELD_IN_JSON "logging.googleapis.com/http_request"
@@ -112,6 +113,7 @@ struct flb_stackdriver {
     flb_sds_t severity_key;
     flb_sds_t trace_key;
     flb_sds_t log_name_key;
+    bool autoformat_stackdriver_trace;
 
     /* oauth2 context */
     struct flb_oauth2 *o;

plugins/out_stackdriver/stackdriver_conf.c

@@ -22,6 +22,7 @@
 #include <fluent-bit/flb_compat.h>
 #include <fluent-bit/flb_info.h>
 #include <fluent-bit/flb_unescape.h>
+#include <fluent-bit/flb_utils.h>
 
 #include <jsmn/jsmn.h>
 
@@ -272,6 +273,14 @@ struct flb_stackdriver *flb_stackdriver_conf_create(struct flb_output_instance *
         ctx->severity_key = flb_sds_create(DEFAULT_SEVERITY_KEY);
     }
 
+    tmp = flb_output_get_property("autoformat_stackdriver_trace", ins);
+    if (tmp) {
+        ctx->autoformat_stackdriver_trace = flb_utils_bool(tmp);
+    }
+    else {
+        ctx->autoformat_stackdriver_trace = FLB_FALSE;
+    }
+    
     tmp = flb_output_get_property("trace_key", ins);
     if (tmp) {
         ctx->trace_key = flb_sds_create(tmp);
@@ -284,6 +293,9 @@ struct flb_stackdriver *flb_stackdriver_conf_create(struct flb_output_instance *
     if (tmp) {
         ctx->log_name_key = flb_sds_create(tmp);
     }
+    else {
+        ctx->log_name_key = flb_sds_create(DEFAULT_LOG_NAME_KEY);
+    }
 
     if (flb_sds_cmp(ctx->resource, "k8s_container",
                     flb_sds_len(ctx->resource)) == 0 || 

tests/runtime/out_stackdriver.c

@@ -572,9 +572,9 @@ static void cb_check_k8s_container_resource_default_regex(void *ctx, int ffd,
     flb_sds_destroy(res_data);
 }
 
-static void cb_check_trace_common_case(void *ctx, int ffd,
-                                       int res_ret, void *res_data, size_t res_size,
-                                       void *data)
+static void cb_check_trace_no_autoformat(void *ctx, int ffd,
+                                         int res_ret, void *res_data, size_t res_size,
+                                         void *data)
 {
     int ret;
 
@@ -589,6 +589,27 @@ static void cb_check_trace_common_case(void *ctx, int ffd,
     flb_sds_destroy(res_data);
 }
 
+static void cb_check_trace_stackdriver_autoformat(void *ctx, int ffd,
+                                                  int res_ret, void *res_data, size_t res_size,
+                                                  void *data)
+{
+    int ret;
+
+    /* trace in the entries */
+    ret = mp_kv_cmp(
+        res_data, 
+        res_size, 
+        "$entries[0]['trace']", 
+        "projects/fluent-bit-test/traces/test-trace-id-xyz");
+    TEST_CHECK(ret == FLB_TRUE);
+
+    /* trace has been removed from jsonPayload */
+    ret = mp_kv_exists(res_data, res_size, "$entries[0]['jsonPayload']['trace']");
+    TEST_CHECK(ret == FLB_FALSE);
+
+    flb_sds_destroy(res_data);
+}
+
 static void cb_check_log_name_override(void *ctx, int ffd,
                                        int res_ret, void *res_data, size_t res_size,
                                        void *data)
@@ -1913,7 +1934,48 @@ void flb_test_resource_global()
     flb_destroy(ctx);
 }
 
-void flb_test_trace_common_case()
+void flb_test_trace_no_autoformat()
+{
+    int ret;
+    int size = sizeof(TRACE_COMMON_CASE) - 1;
+    flb_ctx_t *ctx;
+    int in_ffd;
+    int out_ffd;
+
+    /* Create context, flush every second (some checks omitted here) */
+    ctx = flb_create();
+    flb_service_set(ctx, "flush", "1", "grace", "1", NULL);
+
+    /* Lib input mode */
+    in_ffd = flb_input(ctx, (char *) "lib", NULL);
+    flb_input_set(ctx, in_ffd, "tag", "test", NULL);
+
+    /* Stackdriver output */
+    out_ffd = flb_output(ctx, (char *) "stackdriver", NULL);
+    flb_output_set(ctx, out_ffd,
+                   "match", "test",
+                   "resource", "gce_instance",
+                   "trace_key", "trace",
+                   NULL);
+
+    /* Enable test mode */
+    ret = flb_output_set_test(ctx, out_ffd, "formatter",
+                              cb_check_trace_no_autoformat,
+                              NULL, NULL);
+
+    /* Start */
+    ret = flb_start(ctx);
+    TEST_CHECK(ret == 0);
+
+    /* Ingest data sample */
+    flb_lib_push(ctx, in_ffd, (char *) TRACE_COMMON_CASE, size);
+
+    sleep(2);
+    flb_stop(ctx);
+    flb_destroy(ctx);
+}
+
+void flb_test_trace_stackdriver_autoformat()
 {
     int ret;
     int size = sizeof(TRACE_COMMON_CASE) - 1;
@@ -1935,11 +1997,12 @@ void flb_test_trace_common_case()
                    "match", "test",
                    "resource", "gce_instance",
                    "trace_key", "trace",
+                   "autoformat_stackdriver_trace", "true",
                    NULL);
 
     /* Enable test mode */
     ret = flb_output_set_test(ctx, out_ffd, "formatter",
-                              cb_check_trace_common_case,
+                              cb_check_trace_stackdriver_autoformat,
                               NULL, NULL);
 
     /* Start */
@@ -4108,7 +4171,8 @@ TEST_LIST = {
     {"resource_gce_instance", flb_test_resource_gce_instance },
 
     /* test trace */
-    {"trace_common_case", flb_test_trace_common_case},
+    {"trace_no_autoformat", flb_test_trace_no_autoformat},
+    {"trace_stackdriver_autoformat", flb_test_trace_stackdriver_autoformat},
 
     /* test log name */
     {"log_name_override", flb_test_log_name_override},