pkg/options/types.go: Adjust Set to parse new flag params

Author: lilic

docs/cli-arguments.md

@@ -25,34 +25,34 @@ spec:
 ```txt
 $ kube-state-metrics -h
 Usage of ./kube-state-metrics:
-      --add_dir_header                   If true, adds the file directory to the header of the log messages
-      --alsologtostderr                  log to standard error as well as files
-      --apiserver string                 The URL of the apiserver to use as a master
-      --enable-gzip-encoding             Gzip responses when requested by clients via 'Accept-Encoding: gzip' header.
-  -h, --help                             Print Help text
-      --host string                      Host to expose metrics on. (default "0.0.0.0")
-      --kubeconfig string                Absolute path to the kubeconfig file
-      --labels-allow-list string         list of metric names and labels you would like to allow, metric_name=[label1,labeln...],metric_name[]...
-      --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
-      --log_dir string                   If non-empty, write log files in this directory
-      --log_file string                  If non-empty, use this log file
-      --log_file_max_size uint           Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
-      --logtostderr                      log to standard error instead of files (default true)
-      --metric-allowlist string          Comma-separated list of metrics to be exposed. This list comprises of exact metric names and/or regex patterns. The allowlist and denylist are mutually exclusive.
-      --metric-denylist string           Comma-separated list of metrics not to be enabled. This list comprises of exact metric names and/or regex patterns. The allowlist and denylist are mutually exclusive.
-      --namespaces string                Comma-separated list of namespaces to be enabled. Defaults to ""
-      --pod string                       Name of the pod that contains the kube-state-metrics container. When set, it is expected that --pod and --pod-namespace are both set. Most likely this should be passed via the downward API. This is used for auto-detecting sharding. If set, this has preference over statically configured sharding. This is experimental, it may be removed without notice.
-      --pod-namespace string             Name of the namespace of the pod specified by --pod. When set, it is expected that --pod and --pod-namespace are both set. Most likely this should be passed via the downward API. This is used for auto-detecting sharding. If set, this has preference over statically configured sharding. This is experimental, it may be removed without notice.
-      --port int                         Port to expose metrics on. (default 8080)
-      --resources string                 Comma-separated list of Resources to be enabled. Defaults to "certificatesigningrequests,configmaps,cronjobs,daemonsets,deployments,endpoints,horizontalpodautoscalers,ingresses,jobs,leases,limitranges,mutatingwebhookconfigurations,namespaces,networkpolicies,nodes,persistentvolumeclaims,persistentvolumes,poddisruptionbudgets,pods,replicasets,replicationcontrollers,resourcequotas,secrets,services,statefulsets,storageclasses,validatingwebhookconfigurations,volumeattachments"
-      --shard int32                      The instances shard nominal (zero indexed) within the total number of shards. (default 0)
-      --skip_headers                     If true, avoid header prefixes in the log messages
-      --skip_log_headers                 If true, avoid headers when opening log files
-      --stderrthreshold severity         logs at or above this threshold go to stderr (default 2)
-      --telemetry-host string            Host to expose kube-state-metrics self metrics on. (default "0.0.0.0")
-      --telemetry-port int               Port to expose kube-state-metrics self metrics on. (default 8081)
-      --total-shards int                 The total number of shards. Sharding is disabled when total shards is set to 1. (default 1)
-  -v, --v Level                          number for the log level verbosity
-      --version                          kube-state-metrics build version information
-      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging
+      --add_dir_header                    If true, adds the file directory to the header of the log messages
+      --alsologtostderr                   log to standard error as well as files
+      --apiserver string                  The URL of the apiserver to use as a master
+      --enable-gzip-encoding              Gzip responses when requested by clients via 'Accept-Encoding: gzip' header.
+  -h, --help                              Print Help text
+      --host string                       Host to expose metrics on. (default "0.0.0.0")
+      --kubeconfig string                 Absolute path to the kubeconfig file
+      --labels-metric-allow-list string   Allows to pass a list of additional Kubernetes label keys that will be used in the resource' 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"],...)'
+      --log_backtrace_at traceLocation    when logging hits line file:N, emit a stack trace (default :0)
+      --log_dir string                    If non-empty, write log files in this directory
+      --log_file string                   If non-empty, use this log file
+      --log_file_max_size uint            Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
+      --logtostderr                       log to standard error instead of files (default true)
+      --metric-allowlist string           Comma-separated list of metrics to be exposed. This list comprises of exact metric names and/or regex patterns. The allowlist and denylist are mutually exclusive.
+      --metric-denylist string            Comma-separated list of metrics not to be enabled. This list comprises of exact metric names and/or regex patterns. The allowlist and denylist are mutually exclusive.
+      --namespaces string                 Comma-separated list of namespaces to be enabled. Defaults to ""
+      --pod string                        Name of the pod that contains the kube-state-metrics container. When set, it is expected that --pod and --pod-namespace are both set. Most likely this should be passed via the downward API. This is used for auto-detecting sharding. If set, this has preference over statically configured sharding. This is experimental, it may be removed without notice.
+      --pod-namespace string              Name of the namespace of the pod specified by --pod. When set, it is expected that --pod and --pod-namespace are both set. Most likely this should be passed via the downward API. This is used for auto-detecting sharding. If set, this has preference over statically configured sharding. This is experimental, it may be removed without notice.
+      --port int                          Port to expose metrics on. (default 8080)
+      --resources string                  Comma-separated list of Resources to be enabled. Defaults to "certificatesigningrequests,configmaps,cronjobs,daemonsets,deployments,endpoints,horizontalpodautoscalers,ingresses,jobs,leases,limitranges,mutatingwebhookconfigurations,namespaces,networkpolicies,nodes,persistentvolumeclaims,persistentvolumes,poddisruptionbudgets,pods,replicasets,replicationcontrollers,resourcequotas,secrets,services,statefulsets,storageclasses,validatingwebhookconfigurations,volumeattachments"
+      --shard int32                       The instances shard nominal (zero indexed) within the total number of shards. (default 0)
+      --skip_headers                      If true, avoid header prefixes in the log messages
+      --skip_log_headers                  If true, avoid headers when opening log files
+      --stderrthreshold severity          logs at or above this threshold go to stderr (default 2)
+      --telemetry-host string             Host to expose kube-state-metrics self metrics on. (default "0.0.0.0")
+      --telemetry-port int                Port to expose kube-state-metrics self metrics on. (default 8081)
+      --total-shards int                  The total number of shards. Sharding is disabled when total shards is set to 1. (default 1)
+  -v, --v Level                           number for the log level verbosity
+      --version                           kube-state-metrics build version information
+      --vmodule moduleSpec                comma-separated list of pattern=N settings for file-filtered logging
 ```

pkg/builder/types/interfaces.go

@@ -54,8 +54,3 @@ type AllowDenyLister interface {
 	IsIncluded(string) bool
 	IsExcluded(string) bool
 }
-
-// AllowLabels interface to only allow certain labels for a given metric.
-type AllowLabels interface {
-	Allowed(metric string, labels, values []string) (allowedLabels, allowedValues []string)
-}

pkg/metric_generator/generator.go

@@ -120,30 +120,3 @@ func FilterMetricFamilies(l allowDenyLister, families []FamilyGenerator) []Famil
 
 	return filtered
 }
-
-type allowLabels interface {
-	Allowed(metric string, labels, values []string) (allowedLabels, allowedValues []string)
-}
-
-// FilterMetricFamiliesLabels takes a AllowLabels and a slice of metric
-// families and returns a filtered slice with metric families with their functions adapted to include only allowed labels for that metric Family.
-func FilterMetricFamiliesLabels(allowLabels allowLabels, families []FamilyGenerator) []FamilyGenerator {
-	var filtered []FamilyGenerator
-	for _, f := range families {
-		generateFunc := func(familyGenerator FamilyGenerator) func(obj interface{}) *metric.Family {
-			return func(obj interface{}) *metric.Family {
-				metricFamily := familyGenerator.GenerateFunc(obj)
-
-				for _, m := range metricFamily.Metrics {
-					m.LabelKeys, m.LabelValues = allowLabels.Allowed(familyGenerator.Name, m.LabelKeys, m.LabelValues)
-				}
-				return metricFamily
-			}
-		}(f)
-
-		f.GenerateFunc = generateFunc
-		filtered = append(filtered, f)
-	}
-
-	return filtered
-}

pkg/metric_generator/generator_test.go

@@ -97,7 +97,7 @@ func (o *Options) AddFlags() {
 	o.flags.StringVar(&o.Namespace, "pod-namespace", "", "Name of the namespace of the pod specified by --pod. "+autoshardingNotice)
 	o.flags.BoolVarP(&o.Version, "version", "", false, "kube-state-metrics build version information")
 	o.flags.BoolVar(&o.EnableGZIPEncoding, "enable-gzip-encoding", false, "Gzip responses when requested by clients via 'Accept-Encoding: gzip' header.")
-	o.flags.Var(&o.LabelsAllowList, "labels-allow-list", "list of metric names and labels you would like to allow, metric_name=[label1,labeln...],metric_name[]...")
+	o.flags.Var(&o.LabelsAllowList, "labels-metric-allow-list", "Allows to pass a list of additional Kubernetes label keys that will be used in the resource' 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\"],...)'")
 }
 
 // Parse parses the flag definitions from the argument list.