HPCC-33201 Expose OTel Resource Attribute config options

- Defines new Jtrace Resource Attribute config options - Defaults deploymentEnvironment to development - Provides sample baremetal config section Signed-off-by: Rodrigo Pastrana <[email protected]>
hpcc-systems · Jan 10, 2025 · 5f2dd2b · 5f2dd2b
1 parent 78a4781
commit 5f2dd2b
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 5 deletions.
diff --git a/helm/examples/tracing/baremetal-otlp-http-localhost-sample.xml b/helm/examples/tracing/baremetal-otlp-http-localhost-sample.xml
@@ -0,0 +1,10 @@
+<Environment>
+  <Software>
+  <tracing disabled="false">
+   <resourceAttributes deploymentEnvironment="development" serviceNamespace="cmakeinstall"/>
+   <exporters consoleDebug="true" endpoint="http://localhost:4318/v1/traces" type="OTLP-HTTP">
+    <batch enabled="false" maxQueueSize="4095" scheduledDelayMillis="6001" maxExportBatchSize="511"/>
+   </exporters>
+  </tracing>
+ </Software>
+</Environment>
diff --git a/helm/hpcc/values.schema.json b/helm/hpcc/values.schema.json
@@ -1166,6 +1166,20 @@
           "items": {
             "$ref": "#/definitions/traceExporter"
           }
+        },
+        "resourceAttributes": {
+          "type": "object",
+          "properties": {
+            "deploymentEnvironment": {
+              "type": "string",
+              "description": "Name of the deployment environment (aka deployment tier) such as staging/development/production. "
+            },
+            "serviceNamespace": {
+              "type": "string",
+              "description": "Identifier used to help distinguish instances of same service"
+            }
+          },
+          "additionalProperties": { "type": ["integer", "string", "boolean"] }
         }
       },
       "additionalProperties": { "type": ["integer", "string", "boolean"] }

diff --git a/helm/hpcc/values.yaml b/helm/hpcc/values.yaml
@@ -29,6 +29,8 @@ global:
   tracing:
     disabled: false
     alwaysCreateTraceIds: true
+    resourceAttributes: # used to declare OTEL Resource Attribute config values
+      deploymentEnvironment: development # used to anotate tracing spans' environment identifier (development/production/statiging/etc)
 
   ## resource settings for stub components
   #stubInstanceResources:

diff --git a/system/jlib/jtrace.cpp b/system/jlib/jtrace.cpp
@@ -1342,13 +1342,39 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor> CTraceManager::createP
 
 void CTraceManager::initTracerProviderAndGlobalInternals(const IPropertyTree * traceConfig)
 {
+    /*
+    Service related resourceAttributes supported by otel:
+
+        service.instance.id string	The string ID of the service instance.
+        service.name        string	Logical name of the service.
+        service.namespace   string	A namespace for service.name.
+        service.version     string	The version string of the service API or implementation.
+    */
+    opentelemetry::sdk::resource::ResourceAttributes resourceAtts = 
+        {
+            {"service.name", moduleName.get()},
+            {"service.version", hpccBuildInfo.buildVersion}
+        };
+
     std::vector<std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor>> processors;
 
     //By default trace spans to the logs in debug builds - so that developers get used to seeing them.
     //Default off for release builds to avoid flooding the logs, and because they are likely to use OTLP
     bool enableDefaultLogExporter = isDebugBuild();
     if (traceConfig)
     {
+        IPropertyTree * resourceAttributesTree = traceConfig->queryPropTree("resourceAttributes");
+        if (resourceAttributesTree)
+        {
+            const char * depEnv = resourceAttributesTree->queryProp("@deploymentEnvironment");
+            if (depEnv)
+                resourceAtts.SetAttribute("deployment.environment", depEnv);
+
+            const char * servNS = resourceAttributesTree->queryProp("@serviceNamespace");
+            if (servNS)
+                resourceAtts.SetAttribute("service.namespace", servNS);
+        }
+
         //Administrators can choose to export trace data to a different backend by specifying the exporter type
         Owned<IPropertyTreeIterator> iter = traceConfig->getElements("exporters");
         ForEach(*iter)
@@ -1369,11 +1395,6 @@ void CTraceManager::initTracerProviderAndGlobalInternals(const IPropertyTree * t
         processors.push_back(opentelemetry::sdk::trace::SimpleSpanProcessorFactory::Create(std::move(exporter)));
     }
 
-    opentelemetry::sdk::resource::ResourceAttributes resourceAtts = 
-        {
-            {"service.name", moduleName.get()},
-            {"service.version", hpccBuildInfo.buildVersion}
-        };
     auto jtraceResource = opentelemetry::sdk::resource::Resource::Create(resourceAtts);
 
     // Default is an always-on sampler.
@@ -1412,6 +1433,8 @@ void CTraceManager::initTracer(const IPropertyTree * traceConfig)
             const char * simulatedGlobalYaml = R"!!(global:
   tracing:
     disabled: false
+    resourceAttributes: # used to declare OTEL Resource Attribute config values
+      deploymentEnvironment: testing
     processor:
       type: simple
     exporter: