HPCC-33298 Code review2

- Rename generic config value

Signed-off-by: Rodrigo Pastrana <[email protected]>

Author: rpastrana

helm/examples/tracing/README.md

@@ -15,7 +15,7 @@ All configuration options detailed here are part of the HPCC Systems Helm chart,
 - enableOTELDebugLogging - If true, OTel library logging level set to debug, otherwise warning
 - sampling - Defines head sampling strategy. Decision to sample or drop a span or trace is not made by inspecting the trace as a whole. https://opentelemetry.io/docs/concepts/sampling/
   - type "AlwaysOff" | "AlwaysOn" | "Ratio"
-  - argument - Optional sampling type configuration value. Currently, only supported value applies to the "Ratio" sampling type. The argument value is a string representing a numeric value betwen 0.0 and 1.0. This value represents the ratio of trace/spans to sample
+  - ratio - Required if Ratio sampling type enabled. Represents the ratio of trace/spans to sample Must be a numeric value betwen 0.0 and 1.0. 
   - parentBased - Optional boolean. Determines if the sampling policy honors the remote root span sampled flag
 - resourceAttributes: - Defines OTel specific resource attribute configuration values
                         which are appended to the runtime OTEL_RESOURCE_ATTRIBUTES. See OTel doc: https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration

helm/examples/tracing/baremetal-otlp-http-localhost-sample.xml

@@ -5,7 +5,7 @@
    <exporters consoleDebug="true" endpoint="http://localhost:4318/v1/traces" type="OTLP-HTTP">
     <batch enabled="false" maxQueueSize="4095" scheduledDelayMillis="6001" maxExportBatchSize="511"/>
    </exporters>
-   <sampling type="Ratio" argument="0.1" parentBased="true"/>
+   <sampling type="Ratio" ratio="0.1" parentBased="true"/>
   </tracing>
  </Software>
 </Environment>

helm/examples/tracing/otlp-http-collector-default-sampled.yaml

@@ -2,7 +2,7 @@ global:
   tracing:
     sampling:
       type: Ratio       #Head sampling based on simple ratio
-      argument: "0.1"   #only sample 10% of traces/spans
+      ratio: 0.1        #only sample 10% of traces/spans
       parentBased: true #Sampling strategy based on parent's sampling
     exporters:
     - type: OTLP-HTTP

helm/hpcc/values.schema.json

@@ -1179,9 +1179,9 @@
               "enum": ["AlwaysOff", "AlwaysOn", "Ratio"],
               "description": "Name of the Head Sampling type AlwaysOff|AlwaysOn|Ratio"
             },
-            "argument" : {
-              "type": "string",
-              "description": "Optional - Sampling type specific configuration value. Such as the ratio for the Ratio sampling type."
+              "ratio" : {
+              "type": "number",
+              "description": "Required if sampling type set to Ratio - Represents the sampling ratio value."
             },
             "parentBased" : {
               "type": "boolean",

helm/hpcc/values.yaml

@@ -31,6 +31,11 @@ global:
     alwaysCreateTraceIds: true
     resourceAttributes: # used to declare OTEL Resource Attribute config values
       deploymentEnvironment: development # used to anotate tracing spans' environment identifier (development/production/statiging/etc)
+    sampling:
+      type: Ratio       #Head sampling based on simple ratio
+      ratio: 0.1        #only sample 10% of traces/spans
+      parentBased: true #Sampling strategy based on parent's sampling
+
 
   ## resource settings for stub components
   #stubInstanceResources: