hack/kube-state-metrics: improve static definition

Author: chrischdi

api/v1beta1/cluster_types.go

@@ -490,7 +490,7 @@ func (v APIEndpoint) String() string {
 // +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.topology.version",description="Kubernetes version associated with this Cluster"
 
 // Cluster is the Schema for the clusters API.
-// +Metrics:namePrefix="capi_cluster"
+// +Metrics:gvk:namePrefix="capi_cluster"
 // +Metrics:labelFromPath:name="name",JSONPath=.metadata.name
 // +Metrics:labelFromPath:name="namespace",JSONPath=.metadata.namespace
 // +Metrics:labelFromPath:name="uid",JSONPath=.metadata.uid

api/v1beta1/clusterclass_types.go

@@ -35,7 +35,7 @@ const ClusterClassKind = "ClusterClass"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of ClusterClass"
 
 // ClusterClass is a template which can be used to create managed topologies.
-// +Metrics:namePrefix="capi_clusterclass"
+// +Metrics:gvk:namePrefix="capi_clusterclass"
 // +Metrics:labelFromPath:name="name",JSONPath=.metadata.name
 // +Metrics:labelFromPath:name="namespace",JSONPath=.metadata.namespace
 // +Metrics:labelFromPath:name="uid",JSONPath=.metadata.uid

api/v1beta1/machine_types.go

@@ -285,7 +285,7 @@ type Bootstrap struct {
 // +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.version",description="Kubernetes version associated with this Machine"
 
 // Machine is the Schema for the machines API.
-// +Metrics:namePrefix="capi_machine"
+// +Metrics:gvk:namePrefix="capi_machine"
 // +Metrics:labelFromPath:name="name",JSONPath=".metadata.name"
 // +Metrics:labelFromPath:name="namespace",JSONPath=".metadata.namespace"
 // +Metrics:labelFromPath:name="uid",JSONPath=".metadata.uid"

api/v1beta1/machinedeployment_types.go

@@ -331,7 +331,7 @@ func (md *MachineDeploymentStatus) GetTypedPhase() MachineDeploymentPhase {
 // +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.template.spec.version",description="Kubernetes version associated with this MachineDeployment"
 
 // MachineDeployment is the Schema for the machinedeployments API.
-// +Metrics:namePrefix="capi_machinedeployment"
+// +Metrics:gvk:namePrefix="capi_machinedeployment"
 // +Metrics:labelFromPath:name="name",JSONPath=".metadata.name"
 // +Metrics:labelFromPath:name="namespace",JSONPath=".metadata.namespace"
 // +Metrics:labelFromPath:name="uid",JSONPath=".metadata.uid"

api/v1beta1/machinehealthcheck_types.go

@@ -153,7 +153,7 @@ type MachineHealthCheckStatus struct {
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of MachineHealthCheck"
 
 // MachineHealthCheck is the Schema for the machinehealthchecks API.
-// +Metrics:namePrefix="capi_machinehealthcheck"
+// +Metrics:gvk:namePrefix="capi_machinehealthcheck"
 // +Metrics:labelFromPath:name="name",JSONPath=".metadata.name"
 // +Metrics:labelFromPath:name="namespace",JSONPath=".metadata.namespace"
 // +Metrics:labelFromPath:name="uid",JSONPath=".metadata.uid"

api/v1beta1/machineset_types.go

@@ -219,7 +219,7 @@ func (m *MachineSet) Validate() field.ErrorList {
 // +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.template.spec.version",description="Kubernetes version associated with this MachineSet"
 
 // MachineSet is the Schema for the machinesets API.
-// +Metrics:namePrefix="capi_machineset"
+// +Metrics:gvk:namePrefix="capi_machineset"
 // +Metrics:labelFromPath:name="name",JSONPath=".metadata.name"
 // +Metrics:labelFromPath:name="namespace",JSONPath=".metadata.namespace"
 // +Metrics:labelFromPath:name="uid",JSONPath=".metadata.uid"

bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go

@@ -167,7 +167,7 @@ type KubeadmConfigStatus struct {
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of KubeadmConfig"
 
 // KubeadmConfig is the Schema for the kubeadmconfigs API.
-// +Metrics:namePrefix="capi_kubeadmconfig"
+// +Metrics:gvk:namePrefix="capi_kubeadmconfig"
 // +Metrics:labelFromPath:name="name",JSONPath=.metadata.name
 // +Metrics:labelFromPath:name="namespace",JSONPath=.metadata.namespace
 // +Metrics:labelFromPath:name="uid",JSONPath=.metadata.uid

controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go

@@ -339,7 +339,7 @@ type LastRemediationStatus struct {
 // +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Kubernetes version associated with this control plane"
 
 // KubeadmControlPlane is the Schema for the KubeadmControlPlane API.
-// +Metrics:namePrefix="capi_kubeadmcontrolplane"
+// +Metrics:gvk:namePrefix="capi_kubeadmcontrolplane"
 // +Metrics:labelFromPath:name="cluster_name",JSONPath=.metadata.ownerReferences.\[kind=Cluster\].name
 // +Metrics:labelFromPath:name="name",JSONPath=".metadata.name"
 // +Metrics:labelFromPath:name="namespace",JSONPath=".metadata.namespace"

exp/api/v1beta1/machinepool_types.go

@@ -229,7 +229,7 @@ func (m *MachinePoolStatus) GetTypedPhase() MachinePoolPhase {
 // +k8s:conversion-gen=false
 
 // MachinePool is the Schema for the machinepools API.
-// +Metrics:namePrefix="capi_machinepool"
+// +Metrics:gvk:namePrefix="capi_machinepool"
 // +Metrics:labelFromPath:name="name",JSONPath=".metadata.name"
 // +Metrics:labelFromPath:name="namespace",JSONPath=".metadata.namespace"
 // +Metrics:labelFromPath:name="uid",JSONPath=".metadata.uid"

hack/observability/kube-state-metrics/crd-config.yaml

@@ -584,13 +584,12 @@ spec:
         info:
           labelsFromPath:
             node_name:
-            - status
-            - nodeRef
-            - name
+              - name
             node_uid:
+              - uid
+          path:
             - status
             - nodeRef
-            - uid
         type: Info
     - name: status_phase
       help: The machines current phase.
@@ -926,22 +925,24 @@ spec:
         info:
           # TODO: added metadata.name even it's already defined above as the metric doesn't work with empty labelsFromPath.
           labelsFromPath:
-            name:
-            - metadata
-            - name
+            maxUnhealthy:
+            - spec
+            - maxUnhealthy
         type: Info
     - name: status_current_healthy
       help: Current number of healthy machines.
       each:
         gauge:
+          nilIsZero: true
           path:
           - status
           - currentHealthy
         type: Gauge
     - name: status_expected_machines
-      help: Total number of pods counted by this machinehealthcheck.
+      help: Total number of machines counted by this machinehealthcheck.
       each:
         gauge:
+          nilIsZero: true
           path:
           - status
           - expectedMachines
@@ -950,6 +951,7 @@ spec:
       help: Number of machine remediations that are currently allowed.
       each:
         gauge:
+          nilIsZero: true
           path:
           - status
           - remediationsAllowed
@@ -1104,6 +1106,7 @@ spec:
           path:
           - status
           - fullyLabeledReplicas
+          nilIsZero: true
         type: Gauge
     - name: status_replicas_ready
       help: The number of ready replicas per machineset.
@@ -1256,6 +1259,7 @@ spec:
           nilIsZero: true
         type: Gauge
     - name: info
+      help: Information about a machinepool.
       each:
         type: Info
         info: