forked from kubernetes/kube-state-metrics
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request kubernetes#1988 from dfredell/main
docs: Add cli refrences to the docs around annotations and labels
- Loading branch information
Showing
35 changed files
with
370 additions
and
369 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
# CertificateSigningRequest Metrics | ||
|
||
| Metric name| Metric type | Labels/tags | Status | | ||
| ---------- | ----------- | ----------- | ----------- | | ||
| kube_certificatesigningrequest_annotations | Gauge | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name>| EXPERIMENTAL | | ||
| kube_certificatesigningrequest_created| Gauge | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name>| STABLE | | ||
| kube_certificatesigningrequest_condition | Gauge | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name> <br> `condition`=<approved\|denied> | STABLE | | ||
| kube_certificatesigningrequest_labels | Gauge | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name>| STABLE | | ||
| kube_certificatesigningrequest_cert_length | Gauge | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name>| STABLE | | ||
| Metric name | Metric type | Description | Labels/tags | Status | | ||
| ------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | ||
| kube_certificatesigningrequest_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name> | EXPERIMENTAL | | ||
| kube_certificatesigningrequest_created | Gauge | | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name> | STABLE | | ||
| kube_certificatesigningrequest_condition | Gauge | | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name> <br> `condition`=<approved\|denied> | STABLE | | ||
| kube_certificatesigningrequest_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name> | STABLE | | ||
| kube_certificatesigningrequest_cert_length | Gauge | | `certificatesigningrequest`=<certificatesigningrequest-name> <br> `signer_name`=<certificatesigningrequest-signer-name> | STABLE | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
# ClusterRole Metrics | ||
|
||
| Metric name| Metric type | Labels/tags | Status | | ||
| ---------- | ----------- | ----------- | ----------- | | ||
| kube_clusterrole_annotations | Gauge | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | ||
| kube_clusterrole_labels | Gauge | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | ||
| kube_clusterrole_info | Gauge | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | | ||
| kube_clusterrole_created | Gauge | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | | ||
| kube_clusterrole_metadata_resource_version | Gauge | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | | ||
| Metric name | Metric type | Description | Labels/tags | Status | | ||
| ------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------------ | | ||
| kube_clusterrole_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | | ||
| kube_clusterrole_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | | ||
| kube_clusterrole_info | Gauge | | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | | ||
| kube_clusterrole_created | Gauge | | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | | ||
| kube_clusterrole_metadata_resource_version | Gauge | | `clusterrole`=<clusterrole-name> | EXPERIMENTAL | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,10 @@ | ||
# ClusterRoleBinding Metrics | ||
|
||
| Metric name| Metric type | Labels/tags | Status | | ||
| ---------- | ----------- | ----------- | ----------- | | ||
| kube_clusterrolebinding_annotations | Gauge | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | ||
| kube_clusterrolebinding_labels | Gauge | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | ||
| kube_clusterrolebinding_info | Gauge | `clusterrolebinding`=<clusterrolebinding-name> <br> `roleref_kind`=<role-kind> <br> `roleref_name`=<role-name> | EXPERIMENTAL | | ||
| kube_clusterrolebinding_created | Gauge | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | | ||
| kube_clusterrolebinding_metadata_resource_version | Gauge | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | | ||
| Metric name | Metric type | Description | Labels/tags | Status | | ||
| ------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------ | | ||
| kube_clusterrolebinding_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | | ||
| kube_clusterrolebinding_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | | ||
| kube_clusterrolebinding_info | Gauge | | `clusterrolebinding`=<clusterrolebinding-name> <br> `roleref_kind`=<role-kind> <br> `roleref_name`=<role-name> | EXPERIMENTAL | | ||
| kube_clusterrolebinding_created | Gauge | | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | | ||
| kube_clusterrolebinding_metadata_resource_version | Gauge | | `clusterrolebinding`=<clusterrolebinding-name> | EXPERIMENTAL | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
# ConfigMap Metrics | ||
|
||
| Metric name| Metric type | Labels/tags | Status | | ||
| ---------- | ----------- | ----------- | ----------- | | ||
| kube_configmap_annotations | Gauge | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> <br> `annotation_CONFIGMAP_ANNOTATION`=<CONFIGMAP_ANNOTATION> | EXPERIMENTAL | ||
| kube_configmap_labels | Gauge | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> <br> `label_CONFIGMAP_LABEL`=<CONFIGMAP_LABEL> | STABLE | ||
| kube_configmap_info | Gauge | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> | STABLE | | ||
| kube_configmap_created | Gauge | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> | STABLE | | ||
| kube_configmap_metadata_resource_version | Gauge | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> | EXPERIMENTAL | | ||
| Metric name | Metric type | Description | Labels/tags | Status | | ||
| ---------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | ||
| kube_configmap_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> <br> `annotation_CONFIGMAP_ANNOTATION`=<CONFIGMAP_ANNOTATION> | EXPERIMENTAL | | ||
| kube_configmap_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> <br> `label_CONFIGMAP_LABEL`=<CONFIGMAP_LABEL> | STABLE | | ||
| kube_configmap_info | Gauge | | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> | STABLE | | ||
| kube_configmap_created | Gauge | | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> | STABLE | | ||
| kube_configmap_metadata_resource_version | Gauge | | `configmap`=<configmap-name> <br> `namespace`=<configmap-namespace> | EXPERIMENTAL | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,17 @@ | ||
# CronJob Metrics | ||
|
||
| Metric name| Metric type | Labels/tags | Status | | ||
| ---------- | ----------- | ----------- | ----------- | | ||
| kube_cronjob_annotations | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> <br> `annotation_CRONJOB_ANNOTATION`=<CRONJOB_ANNOTATION> | EXPERIMENTAL | ||
| kube_cronjob_info | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> <br> `schedule`=<schedule> <br> `concurrency_policy`=<concurrency-policy> | STABLE | ||
| kube_cronjob_labels | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> <br> `label_CRONJOB_LABEL`=<CRONJOB_LABEL> | STABLE | ||
| kube_cronjob_created | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | ||
| kube_cronjob_next_schedule_time | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | ||
| kube_cronjob_status_active | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | ||
| kube_cronjob_status_last_schedule_time | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | ||
| kube_cronjob_status_last_successful_time | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | EXPERIMENTAL | ||
| kube_cronjob_spec_suspend | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | ||
| kube_cronjob_spec_starting_deadline_seconds | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | ||
| kube_cronjob_metadata_resource_version| Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | ||
| kube_cronjob_spec_successful_job_history_limit | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | EXPERIMENTAL | ||
| kube_cronjob_spec_failed_job_history_limit | Gauge | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | EXPERIMENTAL | ||
| Metric name | Metric type | Description | Labels/tags | Status | | ||
| ---------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | ||
| kube_cronjob_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> <br> `annotation_CRONJOB_ANNOTATION`=<CRONJOB_ANNOTATION> | EXPERIMENTAL | | ||
| kube_cronjob_info | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> <br> `schedule`=<schedule> <br> `concurrency_policy`=<concurrency-policy> | STABLE | | ||
| kube_cronjob_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> <br> `label_CRONJOB_LABEL`=<CRONJOB_LABEL> | STABLE | | ||
| kube_cronjob_created | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | | ||
| kube_cronjob_next_schedule_time | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | | ||
| kube_cronjob_status_active | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | | ||
| kube_cronjob_status_last_schedule_time | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | | ||
| kube_cronjob_status_last_successful_time | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | EXPERIMENTAL | | ||
| kube_cronjob_spec_suspend | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | | ||
| kube_cronjob_spec_starting_deadline_seconds | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | | ||
| kube_cronjob_metadata_resource_version | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | STABLE | | ||
| kube_cronjob_spec_successful_job_history_limit | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | EXPERIMENTAL | | ||
| kube_cronjob_spec_failed_job_history_limit | Gauge | | `cronjob`=<cronjob-name> <br> `namespace`=<cronjob-namespace> | EXPERIMENTAL | |
Oops, something went wrong.