Do not setup the entities pipeline if Splunk Observability isn't enabled (#1699)

Author: dmitryax

.chloggen/do-not-collect-entities-for-splunk-platform.yaml

@@ -0,0 +1,8 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: 'bug_fix'
+# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other)
+component: agent
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Do not setup the entities pipeline if Splunk Observability isn't enabled.
+# One or more tracking issues related to the change
+issues: [1699]

examples/disable-persistence-queue-traces/rendered_manifests/configmap-agent.yaml

@@ -18,10 +18,6 @@ metadata:
 data:
   relay: |
     exporters:
-      otlphttp/entities:
-        headers:
-          X-SF-Token: ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
-        logs_endpoint: https://ingest..signalfx.com/v3/event
       splunk_hec/platform_logs:
         disable_compression: true
         endpoint: CHANGEME
@@ -376,7 +372,6 @@ data:
         - container
         - pod
         - node
-      nop: null
       otlp:
         protocols:
           grpc:
@@ -475,16 +470,6 @@ data:
           - filelog
           - fluentforward
           - otlp
-        logs/entities:
-          exporters:
-          - otlphttp/entities
-          processors:
-          - memory_limiter
-          - batch
-          - resourcedetection
-          - resource
-          receivers:
-          - nop
         metrics:
           exporters:
           - splunk_hec/platform_metrics

examples/disable-persistence-queue-traces/rendered_manifests/daemonset.yaml

@@ -32,7 +32,7 @@ spec:
         component: otel-collector-agent
         release: default
       annotations:
-        checksum/config: 0d57932a5bd2bdd4f08fd8b27d767fd9f601f1c36d342cd2502116ec2eab2076
+        checksum/config: 112996b2a1fed406e8f2d8f276db819623ebc50c1cf31d001f3e0815841bb019
         kubectl.kubernetes.io/default-container: otel-collector
     spec:
       hostNetwork: true

examples/enable-persistence-queue/rendered_manifests/configmap-agent.yaml

@@ -18,10 +18,6 @@ metadata:
 data:
   relay: |
     exporters:
-      otlphttp/entities:
-        headers:
-          X-SF-Token: ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
-        logs_endpoint: https://ingest..signalfx.com/v3/event
       splunk_hec/platform_logs:
         disable_compression: true
         endpoint: CHANGEME
@@ -376,7 +372,6 @@ data:
         - container
         - pod
         - node
-      nop: null
       otlp:
         protocols:
           grpc:
@@ -475,16 +470,6 @@ data:
           - filelog
           - fluentforward
           - otlp
-        logs/entities:
-          exporters:
-          - otlphttp/entities
-          processors:
-          - memory_limiter
-          - batch
-          - resourcedetection
-          - resource
-          receivers:
-          - nop
         metrics:
           exporters:
           - splunk_hec/platform_metrics

examples/enable-persistence-queue/rendered_manifests/daemonset.yaml

@@ -32,7 +32,7 @@ spec:
         component: otel-collector-agent
         release: default
       annotations:
-        checksum/config: 6eea9313b137899a678f9c0bc8596fd9b109901dab2e8832df69c94a0df92434
+        checksum/config: 63c0ab5c3ad1e8749afdd7cb016a394f58caeff2d3dd144b98b88da968f6531c
         kubectl.kubernetes.io/default-container: otel-collector
     spec:
       hostNetwork: true

examples/multi-metrics/rendered_manifests/configmap-agent.yaml

@@ -18,10 +18,6 @@ metadata:
 data:
   relay: |
     exporters:
-      otlphttp/entities:
-        headers:
-          X-SF-Token: ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
-        logs_endpoint: https://ingest..signalfx.com/v3/event
       splunk_hec/platform_logs:
         disable_compression: true
         endpoint: CHANGEME
@@ -342,7 +338,6 @@ data:
         - container
         - pod
         - node
-      nop: null
       otlp:
         protocols:
           grpc:
@@ -438,16 +433,6 @@ data:
           - filelog
           - fluentforward
           - otlp
-        logs/entities:
-          exporters:
-          - otlphttp/entities
-          processors:
-          - memory_limiter
-          - batch
-          - resourcedetection
-          - resource
-          receivers:
-          - nop
         metrics:
           exporters:
           - splunk_hec/platform_metrics

examples/multi-metrics/rendered_manifests/daemonset.yaml

@@ -32,7 +32,7 @@ spec:
         component: otel-collector-agent
         release: default
       annotations:
-        checksum/config: 12080b80c948155231daff62a430dbd062e6f238bf24df7c20ea630026c7a8dc
+        checksum/config: e95bc0a0180c4fabcf1421c55aa8b87e9ca5506001a7ce5c4b933c5cf0cc6168
         kubectl.kubernetes.io/default-container: otel-collector
     spec:
       hostNetwork: true

examples/only-metrics-platform/rendered_manifests/configmap-agent.yaml

@@ -18,10 +18,6 @@ metadata:
 data:
   relay: |
     exporters:
-      otlphttp/entities:
-        headers:
-          X-SF-Token: ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
-        logs_endpoint: https://ingest..signalfx.com/v3/event
       splunk_hec/platform_metrics:
         disable_compression: true
         endpoint: CHANGEME
@@ -205,7 +201,6 @@ data:
         - container
         - pod
         - node
-      nop: null
       otlp:
         protocols:
           grpc:
@@ -285,16 +280,6 @@ data:
       - k8s_observer
       - zpages
       pipelines:
-        logs/entities:
-          exporters:
-          - otlphttp/entities
-          processors:
-          - memory_limiter
-          - batch
-          - resourcedetection
-          - resource
-          receivers:
-          - nop
         metrics:
           exporters:
           - splunk_hec/platform_metrics

examples/only-metrics-platform/rendered_manifests/daemonset.yaml

@@ -32,7 +32,7 @@ spec:
         component: otel-collector-agent
         release: default
       annotations:
-        checksum/config: ec079ba6a012cc8ad59793899c2de733a30f99ce7d359991c0672120a3cd948b
+        checksum/config: 196ee78c8133c17033d231ceae8363107c6e2230d5dbcdedcdc5fa8ba3546e1d
         kubectl.kubernetes.io/default-container: otel-collector
     spec:
       hostNetwork: true

examples/splunk-enterprise-index-routing/rendered_manifests/configmap-agent.yaml

@@ -18,10 +18,6 @@ metadata:
 data:
   relay: |
     exporters:
-      otlphttp/entities:
-        headers:
-          X-SF-Token: ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
-        logs_endpoint: https://ingest..signalfx.com/v3/event
       splunk_hec/platform_logs:
         disable_compression: true
         endpoint: http://localhost:8088/services/collector
@@ -266,7 +262,6 @@ data:
         storage: file_storage
       fluentforward:
         endpoint: 0.0.0.0:8006
-      nop: null
       otlp:
         protocols:
           grpc:
@@ -312,16 +307,6 @@ data:
           - filelog
           - fluentforward
           - otlp
-        logs/entities:
-          exporters:
-          - otlphttp/entities
-          processors:
-          - memory_limiter
-          - batch
-          - resourcedetection
-          - resource
-          receivers:
-          - nop
       telemetry:
         metrics:
           readers:

examples/splunk-enterprise-index-routing/rendered_manifests/daemonset.yaml

@@ -32,7 +32,7 @@ spec:
         component: otel-collector-agent
         release: default
       annotations:
-        checksum/config: 4efd5411252ced29a54a2107c64bf57fe50b2c47bd60b6cc5caf8bc14ff9479b
+        checksum/config: c2199112cf6f9c4655ac80980aa8da19baea3931694160fbb0ad8f328e46b034
         kubectl.kubernetes.io/default-container: otel-collector
     spec:
       hostNetwork: true

helm-charts/splunk-otel-collector/templates/config/_otel-agent.tpl

@@ -40,8 +40,10 @@ receivers:
     endpoint: 0.0.0.0:8006
   {{- end }}
 
+  {{- if eq (include "splunk-otel-collector.splunkO11yEnabled" .) "true" }}
   # Placeholder receiver needed for discovery mode
   nop:
+  {{- end }}
 
   # Prometheus receiver scraping metrics from the pod itself
   {{- include "splunk-otel-collector.prometheusInternalMetrics" "agent" | nindent 2}}
@@ -860,21 +862,21 @@ exporters:
     {{- end }}
     access_token: ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
     sync_host_metadata: true
-  {{- end }}
 
-  {{- if and (eq (include "splunk-otel-collector.splunkO11yEnabled" .) "true") .Values.featureGates.useControlPlaneMetricsHistogramData }}
+  # To send entities (applicable only if discovery mode is enabled)
+  otlphttp/entities:
+    logs_endpoint: {{ include "splunk-otel-collector.o11yIngestUrl" . }}/v3/event
+    headers:
+      "X-SF-Token": ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
+
+  {{- if .Values.featureGates.useControlPlaneMetricsHistogramData }}
   signalfx/histograms:
     ingest_url: {{ include "splunk-otel-collector.o11yIngestUrl" . }}
     api_url: {{ include "splunk-otel-collector.o11yApiUrl" . }}
     access_token: ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
     send_otlp_histograms: true
   {{- end }}
-
-  # To send entities (applicable only if discovery mode is enabled)
-  otlphttp/entities:
-    logs_endpoint: {{ include "splunk-otel-collector.o11yIngestUrl" . }}/v3/event
-    headers:
-      "X-SF-Token": ${SPLUNK_OBSERVABILITY_ACCESS_TOKEN}
+  {{- end }}
 
 service:
   telemetry:
@@ -1106,7 +1108,18 @@ service:
         {{- end }}
     {{- end }}
 
-    {{- if and (eq (include "splunk-otel-collector.splunkO11yEnabled" .) "true") .Values.featureGates.useControlPlaneMetricsHistogramData }}
+    {{- if eq (include "splunk-otel-collector.splunkO11yEnabled" .) "true" }}
+    logs/entities:
+      # Receivers are added dinamically if discovery mode is enabled
+      receivers: [nop]
+      processors:
+        - memory_limiter
+        - batch
+        - resourcedetection
+        - resource
+      exporters: [otlphttp/entities]
+
+    {{- if .Values.featureGates.useControlPlaneMetricsHistogramData }}
     metrics/histograms:
       receivers:
        - receiver_creator
@@ -1119,16 +1132,7 @@ service:
       exporters:
         - signalfx/histograms
     {{- end }}
-
-    logs/entities:
-      # Receivers are added dinamically if discovery mode is enabled
-      receivers: [nop]
-      processors:
-        - memory_limiter
-        - batch
-        - resourcedetection
-        - resource
-      exporters: [otlphttp/entities]
+    {{- end }}
 {{- end }}
 {{/*
 Discovery properties for the otel-collector agent