Merge pull request #2930 from Colstuwjx/container-env-as-metrics-labels

feat: add container whitelisted envs as metrics labels.

Author: bobbypage

metrics/prometheus.go

@@ -1836,7 +1836,7 @@ func DefaultContainerLabels(container *info.ContainerInfo) map[string]string {
 }
 
 // BaseContainerLabels returns a ContainerLabelsFunc that exports the container
-// name, first alias, image name as well as white listed label values.
+// name, first alias, image name as well as all its white listed env and label values.
 func BaseContainerLabels(whiteList []string) func(container *info.ContainerInfo) map[string]string {
 	whiteListMap := make(map[string]struct{}, len(whiteList))
 	for _, k := range whiteList {
@@ -1856,6 +1856,9 @@ func BaseContainerLabels(whiteList []string) func(container *info.ContainerInfo)
 				set[ContainerLabelPrefix+k] = v
 			}
 		}
+		for k, v := range container.Spec.Envs {
+			set[ContainerEnvPrefix+k] = v
+		}
 		return set
 	}
 }

metrics/prometheus_test.go

@@ -44,6 +44,22 @@ func TestPrometheusCollector(t *testing.T) {
 	testPrometheusCollector(t, reg, "testdata/prometheus_metrics")
 }
 
+func TestPrometheusCollectorWithWhiteList(t *testing.T) {
+	c := NewPrometheusCollector(testSubcontainersInfoProvider{}, func(container *info.ContainerInfo) map[string]string {
+		whitelistedLabels := []string{
+			"no_one_match",
+		}
+		containerLabelFunc := BaseContainerLabels(whitelistedLabels)
+		s := containerLabelFunc(container)
+		s["zone.name"] = "hello"
+		return s
+	}, container.AllMetrics, now, v2.RequestOptions{})
+	reg := prometheus.NewRegistry()
+	reg.MustRegister(c)
+
+	testPrometheusCollector(t, reg, "testdata/prometheus_metrics_whitelist_filtered")
+}
+
 func TestPrometheusCollectorWithPerfAggregated(t *testing.T) {
 	metrics := container.MetricSet{
 		container.PerfMetrics: struct{}{},