Make auto-detection of prometheus metrics disabled by default (signal…

…fx#163) Add an additional "autodetect.prometheus" flag to enable automatic prometheus endpoint detection and make it disabled by default.
KingJ · Jun 16, 2021 · ee7bdae · ee7bdae
1 parent 01d60f3
commit ee7bdae
Show file tree

Hide file tree

Showing 46 changed files with 89 additions and 63 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
 
+## [0.27.0] - 2021-06-15
+
+### Changed
+
+- BREAKING CHANGE: Auto-detection of prometheus metrics is disabled by default (#163). See
+  [Upgrade guideline](https://github.com/signalfx/splunk-otel-collector-chart#0264-to-0270)
+
 ## [0.26.4] - 2021-06-09
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -210,6 +210,20 @@ $ helm install my-splunk-otel-collector \
 
 The [rendered directory](rendered) contains pre-rendered Kubernetes resource manifests.
 
+## Upgrade guidelines
+
+### 0.26.4 to 0.27.0
+
+[#163 Auto-detection of prometheus metrics is disabled by default](https://github.com/signalfx/splunk-otel-collector-chart/pull/163):
+If you rely on automatic prometheus endpoints detection to scrape prometheus
+metrics from pods in your k8s cluster, make sure to add this configuration to
+your values.yaml:
+
+```
+autodetect:
+  prometheus: true
+```
+
 ## License
 
 [Apache Software License version 2.0](LICENSE).
diff --git a/helm-charts/splunk-otel-collector/Chart.yaml b/helm-charts/splunk-otel-collector/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: splunk-otel-collector
-version: 0.26.4
+version: 0.27.0
 description: Splunk OpenTelemetry Connector for Kubernetes
 icon: https://github.com/signalfx/splunk-otel-collector-chart/tree/main/splunk.png
 type: application

diff --git a/helm-charts/splunk-otel-collector/templates/config/_otel-agent.tpl b/helm-charts/splunk-otel-collector/templates/config/_otel-agent.tpl
@@ -52,12 +52,14 @@ receivers:
   receiver_creator:
     watch_observers: [k8s_observer]
     receivers:
+      {{- if .Values.autodetect.prometheus }}
       prometheus_simple:
         # Enable prometheus scraping for pods with standard prometheus annotations
         rule: type == "pod" && annotations["prometheus.io/scrape"] == "true"
         config:
           metrics_path: '`"prometheus.io/path" in annotations ? annotations["prometheus.io/path"] : "/metrics"`'
           endpoint: '`endpoint`:`"prometheus.io/port" in annotations ? annotations["prometheus.io/port"] : 9090`'
+      {{- end }}
 
   kubeletstats:
     collection_interval: 10s

diff --git a/helm-charts/splunk-otel-collector/values.yaml b/helm-charts/splunk-otel-collector/values.yaml
@@ -65,8 +65,21 @@ logsEnabled: true
 
 # environment: production
 
-# Configuration for additional metadata that will be added to all the telemetry
-# as extra attributes.
+################################################################################
+# Optional: Automatic detection of additional metric sources.
+# Set autodetect.prometheus=true if you want the otel-collector agent to scrape
+# prometheus metrics from pods that have prometheus-style annotations like
+# "prometheus.io/scrape"
+################################################################################
+
+autodetect:
+  prometheus: false
+
+################################################################################
+# Optional: Configuration for additional metadata that will be added to all the
+# telemetry as extra attributes.
+################################################################################
+
 extraAttributes:
 
   # Labels that will be collected from k8s pods (in case they are set)

diff --git a/rendered/manifests/agent-only/clusterRole.yaml b/rendered/manifests/agent-only/clusterRole.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 rules:

diff --git a/rendered/manifests/agent-only/clusterRoleBinding.yaml b/rendered/manifests/agent-only/clusterRoleBinding.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 roleRef:

diff --git a/rendered/manifests/agent-only/configmap-fluentd-cri.yaml b/rendered/manifests/agent-only/configmap-fluentd-cri.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-fluentd-cri
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/agent-only/configmap-fluentd-json.yaml b/rendered/manifests/agent-only/configmap-fluentd-json.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-fluentd-json
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/agent-only/configmap-fluentd.yaml b/rendered/manifests/agent-only/configmap-fluentd.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-fluentd
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/agent-only/configmap-otel-agent.yaml b/rendered/manifests/agent-only/configmap-otel-agent.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-otel-agent
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:
@@ -115,12 +115,7 @@ data:
             - targets:
               - ${K8S_POD_IP}:8888
       receiver_creator:
-        receivers:
-          prometheus_simple:
-            config:
-              endpoint: '`endpoint`:`"prometheus.io/port" in annotations ? annotations["prometheus.io/port"] : 9090`'
-              metrics_path: '`"prometheus.io/path" in annotations ? annotations["prometheus.io/path"] : "/metrics"`'
-            rule: type == "pod" && annotations["prometheus.io/scrape"] == "true"
+        receivers: null
         watch_observers:
         - k8s_observer
       sapm:

diff --git a/rendered/manifests/agent-only/configmap-otel-k8s-cluster-receiver.yaml b/rendered/manifests/agent-only/configmap-otel-k8s-cluster-receiver.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-otel-k8s-cluster-receiver
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/agent-only/daemonset.yaml b/rendered/manifests/agent-only/daemonset.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-agent
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
     engine: fluentd
@@ -23,7 +23,7 @@ spec:
         app: splunk-otel-collector
         release: default
       annotations:
-        checksum/config: 6ddcbb95554e7d324790a2c8084e833334368d2003d174f428a7cb492e4940b3
+        checksum/config: 31d234b57a23c70a286e04dc535276afc4e1bc1d41e99778d1d5ff16d1584800
     spec:
       hostNetwork: true
       dnsPolicy: ClusterFirstWithHostNet

diff --git a/rendered/manifests/agent-only/deployment-k8s-cluster-receiver.yaml b/rendered/manifests/agent-only/deployment-k8s-cluster-receiver.yaml
@@ -7,7 +7,7 @@ metadata:
   labels:
     app: splunk-otel-collector
     component: otel-k8s-cluster-receiver
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 spec:
@@ -24,7 +24,7 @@ spec:
         component: otel-k8s-cluster-receiver
         release: default
       annotations:
-        checksum/config: 720b87f36e82118d3038288a7cb906967b7f199f4f6bebe429fb6ec7311ed12f
+        checksum/config: aae6f77ea8e569efa22900b2d41320d11939ff70ab1abab0b9e347f25aedcfbc
     spec:
       serviceAccountName: default-splunk-otel-collector
       containers:

diff --git a/rendered/manifests/agent-only/secret.yaml b/rendered/manifests/agent-only/secret.yaml
@@ -6,7 +6,7 @@ metadata:
   name: splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 type: Opaque

diff --git a/rendered/manifests/agent-only/serviceAccount.yaml b/rendered/manifests/agent-only/serviceAccount.yaml
@@ -6,6 +6,6 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
diff --git a/rendered/manifests/gateway-only/clusterRole.yaml b/rendered/manifests/gateway-only/clusterRole.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 rules:

diff --git a/rendered/manifests/gateway-only/clusterRoleBinding.yaml b/rendered/manifests/gateway-only/clusterRoleBinding.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 roleRef:

diff --git a/rendered/manifests/gateway-only/configmap-otel-collector.yaml b/rendered/manifests/gateway-only/configmap-otel-collector.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/gateway-only/deployment-collector.yaml b/rendered/manifests/gateway-only/deployment-collector.yaml
@@ -7,7 +7,7 @@ metadata:
   labels:
     app: splunk-otel-collector
     component: otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 spec:
@@ -24,7 +24,7 @@ spec:
         component: otel-collector
         release: default
       annotations:
-        checksum/config: 684037bd096a49fffb5644b90d2160ad48d0773e6268dc856b1d2b6b4110c851
+        checksum/config: 7cb28f7b6e64bfefab003794453d1f67813eb81e6eb4dfe88be170bf14c6b100
     spec:
       serviceAccountName: default-splunk-otel-collector
       containers:

diff --git a/rendered/manifests/gateway-only/secret.yaml b/rendered/manifests/gateway-only/secret.yaml
@@ -6,7 +6,7 @@ metadata:
   name: splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 type: Opaque

diff --git a/rendered/manifests/gateway-only/service.yaml b/rendered/manifests/gateway-only/service.yaml
@@ -7,7 +7,7 @@ metadata:
   labels:
     app: splunk-otel-collector
     component: otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 spec:

diff --git a/rendered/manifests/gateway-only/serviceAccount.yaml b/rendered/manifests/gateway-only/serviceAccount.yaml
@@ -6,6 +6,6 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
diff --git a/rendered/manifests/logs-only/clusterRole.yaml b/rendered/manifests/logs-only/clusterRole.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 rules:

diff --git a/rendered/manifests/logs-only/clusterRoleBinding.yaml b/rendered/manifests/logs-only/clusterRoleBinding.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 roleRef:

diff --git a/rendered/manifests/logs-only/configmap-fluentd-cri.yaml b/rendered/manifests/logs-only/configmap-fluentd-cri.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-fluentd-cri
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/logs-only/configmap-fluentd-json.yaml b/rendered/manifests/logs-only/configmap-fluentd-json.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-fluentd-json
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/logs-only/configmap-fluentd.yaml b/rendered/manifests/logs-only/configmap-fluentd.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-fluentd
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/logs-only/configmap-otel-agent.yaml b/rendered/manifests/logs-only/configmap-otel-agent.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-otel-agent
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 data:

diff --git a/rendered/manifests/logs-only/daemonset.yaml b/rendered/manifests/logs-only/daemonset.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector-agent
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
     engine: fluentd
@@ -23,7 +23,7 @@ spec:
         app: splunk-otel-collector
         release: default
       annotations:
-        checksum/config: 21bc6edfc4ea6c41d9b45d4fd84293b8a5fe5f81c8eaa72fe2828380e374ef6d
+        checksum/config: 6822bfb810b0bf9d3bbe193397181b3564e866e47ed03e1f2bcfb6f3ec058df5
     spec:
       hostNetwork: true
       dnsPolicy: ClusterFirstWithHostNet

diff --git a/rendered/manifests/logs-only/secret.yaml b/rendered/manifests/logs-only/secret.yaml
@@ -6,7 +6,7 @@ metadata:
   name: splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 type: Opaque

diff --git a/rendered/manifests/logs-only/serviceAccount.yaml b/rendered/manifests/logs-only/serviceAccount.yaml
@@ -6,6 +6,6 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
diff --git a/rendered/manifests/metrics-only/clusterRole.yaml b/rendered/manifests/metrics-only/clusterRole.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 rules:

diff --git a/rendered/manifests/metrics-only/clusterRoleBinding.yaml b/rendered/manifests/metrics-only/clusterRoleBinding.yaml
@@ -6,7 +6,7 @@ metadata:
   name: default-splunk-otel-collector
   labels:
     app: splunk-otel-collector
-    chart: splunk-otel-collector-0.26.4
+    chart: splunk-otel-collector-0.27.0
     release: default
     heritage: Helm
 roleRef: