You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli-arguments.md
+38-38Lines changed: 38 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,42 +25,42 @@ spec:
25
25
```txt
26
26
$ kube-state-metrics -h
27
27
Usage of ./kube-state-metrics:
28
-
--add_dir_header If true, adds the file directory to the header of the log messages
29
-
--alsologtostderr log to standard error as well as files
30
-
--apiserver string The URL of the apiserver to use as a master
31
-
--custom-resource-state-config Inline YAML configuration for Custom Resource State metrics. See documentation for more details.
32
-
--custom-resource-state-config-file Path to a YAML file to configure Custom Resource State metrics.
33
-
--enable-gzip-encoding Gzip responses when requested by clients via 'Accept-Encoding: gzip' header.
34
-
-h, --help Print Help text
35
-
--host string Host to expose metrics on. (default "::")
36
-
--kubeconfig string Absolute path to the kubeconfig file
37
-
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
38
-
--log_dir string If non-empty, write log files in this directory
39
-
--log_file string If non-empty, use this log file
40
-
--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)
41
-
--logtostderr log to standard error instead of files (default true)
42
-
--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.
43
-
--metric-annotations-allowlist string Comma-separated list of Kubernetes annotations keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional annotations provide a list of resource names in their plural form and Kubernetes annotation keys you would like to allow for them (Example: '=namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...)'. A single '*' can be provided per resource instead to allow any annotations, but that has severe performance implications (Example: '=pods=[*]').
44
-
--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.
45
-
--metric-labels-allowlist string Comma-separated 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],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (Example: '=pods=[*]').
46
-
--metric-opt-in-list string Comma-separated list of metrics which are opt-in and not enabled by default. This is in addition to the metric allow- and denylists
47
-
--namespaces string Comma-separated list of namespaces to be enabled. Defaults to ""
48
-
--namespaces-denylist string Comma-separated list of namespaces not to be enabled. If namespaces and namespaces-denylist are both set, only namespaces that are excluded in namespaces-denylist will be used.
49
-
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level)
50
-
--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.
51
-
--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.
52
-
--port int Port to expose metrics on. (default 8080)
53
-
--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"
54
-
--shard int32 The instances shard nominal (zero indexed) within the total number of shards. (default 0)
55
-
--skip_headers If true, avoid header prefixes in the log messages
56
-
--skip_log_headers If true, avoid headers when opening log files
57
-
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
58
-
--telemetry-host string Host to expose kube-state-metrics self metrics on. (default "::")
59
-
--telemetry-port int Port to expose kube-state-metrics self metrics on. (default 8081)
60
-
--tls-config string Path to the TLS configuration file
61
-
--total-shards int The total number of shards. Sharding is disabled when total shards is set to 1. (default 1)
62
-
--use-apiserver-cache Sets resourceVersion=0 for ListWatch requests, using cached resources from the apiserver instead of an etcd quorum read.
63
-
-v, --v Level number for the log level verbosity
64
-
--version kube-state-metrics build version information
65
-
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
28
+
--add_dir_header If true, adds the file directory to the header of the log messages
29
+
--alsologtostderr log to standard error as well as files
30
+
--apiserver string The URL of the apiserver to use as a master
31
+
--custom-resource-state-config string Inline Custom Resource State Metrics config YAML
32
+
--custom-resource-state-config-file string Path to a Custom Resource State Metrics config file (experimental)
33
+
--enable-gzip-encoding Gzip responses when requested by clients via 'Accept-Encoding: gzip' header.
34
+
-h, --help Print Help text
35
+
--host string Host to expose metrics on. (default "::")
36
+
--kubeconfig string Absolute path to the kubeconfig file
37
+
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
38
+
--log_dir string If non-empty, write log files in this directory
39
+
--log_file string If non-empty, use this log file
40
+
--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)
41
+
--logtostderr log to standard error instead of files (default true)
42
+
--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.
43
+
--metric-annotations-allowlist string Comma-separated list of Kubernetes annotations keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional annotations provide a list of resource names in their plural form and Kubernetes annotation keys you would like to allow for them (Example: '=namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...)'. A single '*' can be provided per resource instead to allow any annotations, but that has severe performance implications (Example: '=pods=[*]').
44
+
--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.
45
+
--metric-labels-allowlist string Comma-separated 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],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (Example: '=pods=[*]').
46
+
--metric-opt-in-list string Comma-separated list of metrics which are opt-in and not enabled by default. This is in addition to the metric allow- and denylists
47
+
--namespaces string Comma-separated list of namespaces to be enabled. Defaults to ""
48
+
--namespaces-denylist string Comma-separated list of namespaces not to be enabled. If namespaces and namespaces-denylist are both set, only namespaces that are excluded in namespaces-denylist will be used.
49
+
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level)
50
+
--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.
51
+
--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.
52
+
--port int Port to expose metrics on. (default 8080)
53
+
--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"
54
+
--shard int32 The instances shard nominal (zero indexed) within the total number of shards. (default 0)
55
+
--skip_headers If true, avoid header prefixes in the log messages
56
+
--skip_log_headers If true, avoid headers when opening log files
57
+
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
58
+
--telemetry-host string Host to expose kube-state-metrics self metrics on. (default "::")
59
+
--telemetry-port int Port to expose kube-state-metrics self metrics on. (default 8081)
60
+
--tls-config string Path to the TLS configuration file
61
+
--total-shards int The total number of shards. Sharding is disabled when total shards is set to 1. (default 1)
62
+
--use-apiserver-cache Sets resourceVersion=0 for ListWatch requests, using cached resources from the apiserver instead of an etcd quorum read.
63
+
-v, --v Level number for the log level verbosity
64
+
--version kube-state-metrics build version information
65
+
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
0 commit comments