Merge pull request #18807 from rpastrana/HPCC-32131-JtraceExportersBatch

HPCC-32131 Jtrace exporters batch config support Reviewed-by: Gavin Halliday <[email protected]> Merged-by: Gavin Halliday <[email protected]>
hpcc-systems · Jun 26, 2024 · a7aeeb7 · a7aeeb7
2 parents ee7c3bf + 7fcb208
commit a7aeeb7
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 12 deletions.
diff --git a/helm/examples/tracing/otlp-grpc-collector-default.yaml b/helm/examples/tracing/otlp-grpc-collector-default.yaml
@@ -4,3 +4,8 @@ global:
     - type: OTLP-GRPC
       endpoint: "localhost:4317"
       useSslCredentials: false
+      batch:
+        enabled: true
+        maxQueueSize: 4096
+        scheduledDelayMillis: 6000
+        maxExportBatchSize: 512
diff --git a/helm/examples/tracing/otlp-grpc-collector-k8s.yaml b/helm/examples/tracing/otlp-grpc-collector-k8s.yaml
@@ -4,3 +4,8 @@ global:
     - type: OTLP-GRPC
       endpoint: "http://myotelcollector-opentelemetry-collector.default.svc.cluster.local:4317"
       useSslCredentials: false
+      batch:
+        enabled: true
+        maxQueueSize: 4096
+        scheduledDelayMillis: 6000
+        maxExportBatchSize: 512
diff --git a/helm/examples/tracing/otlp-http-collector-default.yaml b/helm/examples/tracing/otlp-http-collector-default.yaml
@@ -3,4 +3,9 @@ global:
     exporters:
     - type: OTLP-HTTP
       endpoint: "localhost:4318/v1/traces"
-      consoleDebug: true
+      consoleDebug: true
+      batch:
+        enabled: true
+        maxQueueSize: 4096
+        scheduledDelayMillis: 6000
+        maxExportBatchSize: 512
diff --git a/helm/examples/tracing/otlp-http-collector-k8s.yaml b/helm/examples/tracing/otlp-http-collector-k8s.yaml
@@ -4,3 +4,8 @@ global:
     - type: OTLP-HTTP
       endpoint: "http://myotelcollector-opentelemetry-collector.default.svc.cluster.local:4318/v1/traces"
       consoleDebug: true
+      batch:
+        enabled: true
+        maxQueueSize: 4096
+        scheduledDelayMillis: 6000
+        maxExportBatchSize: 512
diff --git a/helm/hpcc/values.schema.json b/helm/hpcc/values.schema.json
@@ -1165,6 +1165,18 @@
             "enabled": {
               "type": "boolean",
               "description": "If true, trace data is processed in a batch, if false, trace data is processed immediately"
+            },
+            "maxQueueSize": {
+              "type": "number",
+              "description": "The maximum buffer/queue size. After the size is reached, spans are dropped."
+            },
+            "scheduledDelayMillis": {
+              "type": "number",
+              "description": "The time interval between two consecutive exports."
+            },
+            "maxExportBatchSize": {
+              "type": "number",
+              "description": " The maximum batch size of every export. It must be smaller or equal to max_queue_size."
             }
           },
           "additionalProperties": { "type": ["integer", "string", "boolean"] }

diff --git a/system/jlib/jtrace.cpp b/system/jlib/jtrace.cpp
@@ -494,7 +494,7 @@ class CTraceManager : implements ITraceManager, public CInterface
     void initTracerProviderAndGlobalInternals(const IPropertyTree * traceConfig);
     void initTracer(const IPropertyTree * traceConfig);
     void cleanupTracer();
-    std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> createExporter(const IPropertyTree * exportConfig);
+    std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> createExporter(const IPropertyTree * exportConfig, bool & shouldBatch);
     std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor> createProcessor(const IPropertyTree * exportConfig);
 
 public:
@@ -1159,10 +1159,11 @@ IProperties * getSpanContext(const ISpan * span)
 
 //---------------------------------------------------------------------------------------------------------------------
 
-std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> CTraceManager::createExporter(const IPropertyTree * exportConfig)
+std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> CTraceManager::createExporter(const IPropertyTree * exportConfig, bool & shouldBatch)
 {
     assertex(exportConfig);
 
+    shouldBatch = true;
     StringBuffer exportType;
     exportConfig->getProp("@type", exportType);
 
@@ -1172,6 +1173,7 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> CTraceManager::createEx
         if (stricmp(exportType.str(), "OS")==0) //To stdout/err
         {
             LOG(MCoperatorInfo, "Tracing exporter set OS");
+            shouldBatch = false;
             return opentelemetry::exporter::trace::OStreamSpanExporterFactory::Create();
         }
         else if (stricmp(exportType.str(), "OTLP")==0 || stricmp(exportType.str(), "OTLP-HTTP")==0)
@@ -1255,6 +1257,7 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> CTraceManager::createEx
             if (logFlags == SpanLogFlags::LogNone)
                 logFlags = DEFAULT_SPAN_LOG_FLAGS;
 
+            shouldBatch = false;
             LOG(MCoperatorInfo, "Tracing exporter set to JLog: logFlags( LogAttributes LogParentInfo %s)", logFlagsStr.str());
             return JLogSpanExporterFactory::Create(logFlags);
         }
@@ -1268,10 +1271,11 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> CTraceManager::createEx
 
 std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor> CTraceManager::createProcessor(const IPropertyTree * exportConfig)
 {
+    bool batchDefault; //to be determined by the createExporter function
     std::unique_ptr<opentelemetry::v1::sdk::trace::SpanExporter> exporter;
     try
     {
-        exporter = createExporter(exportConfig);
+        exporter = createExporter(exportConfig, batchDefault);
     }
     catch(const std::exception& e) //polymorphic type std::exception
     {
@@ -1285,16 +1289,25 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor> CTraceManager::createP
     if (!exporter)
         return nullptr;
 
-    if (exportConfig->getPropBool("batch/@enabled", false))
+    if (exportConfig->getPropBool("batch/@enabled", batchDefault))
     {
         //Groups several spans together, before sending them to an exporter.
-        //MORE: These options should be configurable from batch/@option
-        opentelemetry::v1::sdk::trace::BatchSpanProcessorOptions options; //size_t max_queue_size = 2048;
-                                                                        //The time interval between two consecutive exports
-                                                                        //std::chrono::milliseconds(5000);
-                                                                        //The maximum batch size of every export. It must be smaller or
-                                                                        //equal to max_queue_size.
-                                                                        //size_t max_export_batch_size = 512
+        opentelemetry::v1::sdk::trace::BatchSpanProcessorOptions options;
+        /**
+         * The maximum buffer/queue size. After the size is reached, spans are
+         * dropped.
+         */
+        options.max_queue_size = exportConfig->getPropInt("batch/@maxQueueSize", 2048);
+
+        /* The time interval between two consecutive exports. */
+        options.schedule_delay_millis = std::chrono::milliseconds(exportConfig->getPropInt("batch/@scheduledDelayMillis", 5000));
+
+        /**
+         * The maximum batch size of every export. It must be smaller or
+         * equal to max_queue_size.
+         */
+        options.max_export_batch_size = exportConfig->getPropInt("batch/@maxExportBatchSize", 512);
+
         return opentelemetry::sdk::trace::BatchSpanProcessorFactory::Create(std::move(exporter), options);
     }