|
21 | 21 |
|
22 | 22 | ## Available options
|
23 | 23 |
|
| 24 | +<!-- markdownlint-disable blanks-around-fences --> |
| 25 | +<!-- markdownlint-disable link-image-reference-definitions --> |
| 26 | +[embedmd]:# (../help.txt) |
24 | 27 | ```txt
|
25 | 28 | $ kube-state-metrics -h
|
26 | 29 | kube-state-metrics is a simple service that listens to the Kubernetes API server and generates metrics about the state of the objects.
|
|
52 | 55 | --log_file_max_size uint Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
|
53 | 56 | --logtostderr log to standard error instead of files (default true)
|
54 | 57 | --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.
|
55 |
| - --metric-annotations-allowlist string Comma-separated list of Kubernetes annotations keys that will be used in the resource' labels metric. By default the annotations metrics are not exposed. To include them, 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=[*]'). Additionally, an asterisk (*) can be provided as a key, which will resolve to all resources, i.e., assuming '--resources=deployments,pods', '=*=[*]' will resolve to '=deployments=[*],pods=[*]'. |
| 58 | + --metric-annotations-allowlist string Comma-separated list of Kubernetes annotations keys that will be used in the resource' labels metric. By default the annotations metrics are not exposed. To include them, 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=[*]'). |
56 | 59 | --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.
|
57 | 60 | --metric-labels-allowlist string Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the labels metrics are not exposed. To include them, 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=[*]'). Additionally, an asterisk (*) can be provided as a key, which will resolve to all resources, i.e., assuming '--resources=deployments,pods', '=*=[*]' will resolve to '=deployments=[*],pods=[*]'.
|
58 | 61 | --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
|
|
67 | 70 | --shard int32 The instances shard nominal (zero indexed) within the total number of shards. (default 0)
|
68 | 71 | --skip_headers If true, avoid header prefixes in the log messages
|
69 | 72 | --skip_log_headers If true, avoid headers when opening log files (no effect when -logtostderr=true)
|
70 |
| - --stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=false) (default 2) |
| 73 | + --stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2) |
71 | 74 | --telemetry-host string Host to expose kube-state-metrics self metrics on. (default "::")
|
72 | 75 | --telemetry-port int Port to expose kube-state-metrics self metrics on. (default 8081)
|
73 | 76 | --tls-config string Path to the TLS configuration file
|
|
78 | 81 |
|
79 | 82 | Use "kube-state-metrics [command] --help" for more information about a command.
|
80 | 83 | ```
|
| 84 | +<!-- markdownlint-enable link-image-reference-definitions --> |
| 85 | +<!-- markdownlint-enable blanks-around-fences --> |
0 commit comments