Merge pull request #1253 from porter-dev/metrics-label-allowlist

Add metric labels allowlist argument to kube state metrics

addons/prometheus/charts/kube-state-metrics/templates/deployment.yaml

@@ -156,6 +156,9 @@ spec:
 {{ if .Values.kubeconfig.enabled }}
         - --kubeconfig=/opt/k8s/.kube/config
 {{ end }}
+{{- if .Values.metricLabelsAllowlist }}
+        - --metric-labels-allowlist={{ .Values.metricLabelsAllowlist | join "," }}
+{{- end }}
 {{- if .Values.kubeconfig.enabled }}
         volumeMounts:
         - name: kubeconfig

addons/prometheus/charts/kube-state-metrics/values.yaml

@@ -92,6 +92,16 @@ tolerations: []
 # Annotations to be added to the pod
 podAnnotations: {}
 
+# Comma-separated list of additional Kubernetes label keys that will be used in the resource's
+# labels metric. By default the metric contains only name and namespace labels.
+# To include additional labels, provide a list of resource names in their plural form and Kubernetes
+# label keys you would like to allow for them (Example: '=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'.
+# A single '*' can be provided per resource instead to allow any labels, but that has
+# severe performance implications (Example: '=pods=[*]').
+metricLabelsAllowlist:
+  # This label is used by the porter agent to group and aggregate resource usage metrics for billing
+  - pods[porter.run/project-id]
+
 ## Assign a PriorityClassName to pods if set
 # priorityClassName: ""