Fetch all attributes (#273)

UPGRADING.md

@@ -16,6 +16,11 @@ If you provide access token for Splunk Observability using a custom Kubernetes
 secret (secter.create=false), please update the secret name from
 `splunk_o11y_access_token` to `splunk_observability_access_token`
 
+[#273 Changed configuration to fetch attributes from labels and annotations of pods and namespaces](https://github.com/signalfx/splunk-otel-collector-chart/pull/273)
+
+The following parameter `podLabels` under the `extraAttributes` group is changed to `fromLabels`
+This parameter needs to be updated in your custom values.yaml
+
 ## 0.36.2 to 0.37.0
 
 [#232 Access to underlying node's filesystem was reduced to the minimum scope

helm-charts/splunk-otel-collector/templates/NOTES.txt

@@ -41,3 +41,7 @@ Splunk OpenTelemetry Connector is installed and configured to send data to Splun
 [WARNING] "provider" parameter is deprecated, please use "cloudProvider" instead.
           Upgrade guidelines: https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0371-to-0380
 {{ end }}
+{{- if not (eq (toString .Values.extraAttributes.podLabels) "<nil>") }}
+[WARNING] ".Values.extraAttributes.podLabels" parameter is deprecated, please use ".Values.extraAttributes.fromLabels" instead.
+          Upgrade guidelines: https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0371-to-0380
+{{ end }}

helm-charts/splunk-otel-collector/templates/config/_common.tpl

@@ -228,3 +228,21 @@ splunk_hec/platform_metrics:
     ca_file: /otel/etc/splunk_platform_hec_ca_file
     {{- end }}
 {{- end }}
+
+{{/*
+Add Extra Labels
+*/}}
+{{- define "splunk-otel-collector.addExtraLabels" -}}
+{{- with .Values.extraAttributes.fromLabels }}
+{{ . | toYaml}}
+{{- end }}
+{{- end }}
+
+{{/*
+Add Extra Annotations
+*/}}
+{{- define "splunk-otel-collector.addExtraAnnotations" -}}
+{{- with .Values.extraAttributes.fromAnnotations }}
+{{ . | toYaml}}
+{{- end }}
+{{- end }}

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

@@ -282,11 +282,13 @@ processors:
         - key: splunk.com/index
           tag_name: com.splunk.index
           from: pod
-      {{- with .Values.extraAttributes.podLabels }}
+        {{- include "splunk-otel-collector.addExtraAnnotations" . | nindent 8 }}
+      {{- if or .Values.extraAttributes.podLabels .Values.extraAttributes.fromLabels }}
       labels:
-        {{- range . }}
+        {{- range .Values.extraAttributes.podLabels }}
         - key: {{ . }}
         {{- end }}
+        {{- include "splunk-otel-collector.addExtraLabels" . | nindent 8 }}
       {{- end }}
 
   {{- if eq .Values.logsEngine "fluentd" }}

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

@@ -65,11 +65,13 @@ processors:
         - key: splunk.com/index
           tag_name: com.splunk.index
           from: pod
-      {{- with .Values.extraAttributes.podLabels }}
+        {{- include "splunk-otel-collector.addExtraAnnotations" . | nindent 8 }}
+      {{- if or .Values.extraAttributes.podLabels .Values.extraAttributes.fromLabels }}
       labels:
-        {{- range . }}
+        {{- range .Values.extraAttributes.podLabels }}
         - key: {{ . }}
         {{- end }}
+        {{- include "splunk-otel-collector.addExtraLabels" . | nindent 8 }}
       {{- end }}
 
   {{- include "splunk-otel-collector.resourceLogsProcessor" . | nindent 2 }}

helm-charts/splunk-otel-collector/values.schema.json

@@ -234,6 +234,18 @@
             "type": "string"
           }
         },
+        "fromLabels": {
+          "type": "array",
+          "items": {
+            "type": "object"
+          }
+        },
+        "fromAnnotations": {
+          "type": "array",
+          "items": {
+            "type": "object"
+          }
+        },
         "custom": {
           "type": "array",
           "items": {

helm-charts/splunk-otel-collector/values.yaml

@@ -159,13 +159,30 @@ autodetect:
 
 extraAttributes:
 
-  # Labels that will be collected from k8s pods (in case they are set)
-  # and added  as extra attributes to the telemetry in the following format:
-  # k8s.pod.labels.<label_name>: <label_value>
-  podLabels:
-    - app
-    # - k8s-app
-    # - release
+  # Labels that will be collected from k8s pods (or namespaces) (in case they are set)
+  # and added as extra attributes to the telemetry in the following format:
+  # k8s.<pod|namespace>.labels.<label_name>: <label_value>
+  #  For example, if you want to collect "my_key" label from your namespaces, you could use the following:
+  #  fromLabels:
+  #    - key: my_key
+  #      from: namespace
+  #  If you want to collect all labels from your pods, you could do that using a `key_regex: .*` option, e.g.:
+  #  fromLabels:
+  #    - key_regex: .*
+  #      from: pod
+  #  If you want to change the default attribute name `k8s.pod.labels.<label_name>`, you could do that using a `tag_name` field:
+  #  fromLabels:
+  #    - key: my_key
+  #      tag_name: my_tag
+  #      from: pod
+  fromLabels:
+    - key: app
+
+  # Annotations that will be collected from k8s pods (or namespaces) (in case they are set)
+  # and added as extra attributes to the telemetry in the following format:
+  # k8s.<pod|namespace>.annotations.<annotation_name>: <annotation_value>
+  # fromAnnotations uses the same extraction rules as fromLabels option so refer examples from the fromLabels option.
+  fromAnnotations: []
 
   # List of hardcoded key/value pairs that will be added as attributes to
   # all the telemetry.