set all required markers

Author: chrischdi

api/v1beta1/machine_types.go

@@ -142,6 +142,7 @@ type MachineSpec struct {
 type MachineStatus struct {
 	// NodeRef will point to the corresponding Node if it exists.
 	// +optional
+	// +Metrics:info:name="status_noderef",help="Information about the node reference of a machine.",labelsFromPath={node_name:{"name"},node_uid:{"uid"}}
 	NodeRef *corev1.ObjectReference `json:"nodeRef,omitempty"`
 
 	// NodeInfo is a set of ids/uuids to uniquely identify the node.
@@ -194,11 +195,13 @@ type MachineStatus struct {
 	// Addresses is a list of addresses assigned to the machine.
 	// This field is copied from the infrastructure provider reference.
 	// +optional
+	// +Metrics:info:name="addresses",help="Address information about a machine.",labelsFromPath={address:{address},type:{type}}
 	Addresses MachineAddresses `json:"addresses,omitempty"`
 
 	// Phase represents the current phase of machine actuation.
 	// E.g. Pending, Running, Terminating, Failed etc.
 	// +optional
+	// +Metrics:stateset:name="status_phase",help="The machines current phase.",labelName="phase",list={"Pending","Provisioning","Provisioned","Running","Deleting","Deleted","Failed","Unknown"}
 	Phase string `json:"phase,omitempty"`
 
 	// CertificatesExpiryDate is the expiry date of the machine certificates.
@@ -220,6 +223,7 @@ type MachineStatus struct {
 
 	// Conditions defines current service state of the Machine.
 	// +optional
+	// +Metrics:stateset:name="status_condition",help="The condition of a machine.",labelName="status",JSONPath={"status"},list={"True","False","Unknown"},labelsFromPath={"type":{"type"}}
 	Conditions Conditions `json:"conditions,omitempty"`
 }
 
@@ -279,8 +283,17 @@ 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:labelFromPath:name="name",JSONPath={"metadata","name"}
+// +Metrics:labelFromPath:name="namespace",JSONPath={"metadata","namespace"}
+// +Metrics:labelFromPath:name="uid",JSONPath={"metadata","uid"}
+// +Metrics:labelFromPath:name="cluster_name",JSONPath={"spec","clusterName"}
+// +Metrics:info:name="info",help="Information about a machine.",labelsFromPath={container_runtime_version:{status,nodeInfo,containerRuntimeVersion},failure_domain:{spec,failureDomain},kernel_version:{status,nodeInfo,kernelVersion},kube_proxy_version:{status,nodeInfo,kubeProxyVersion},kubelet_version:{status,nodeInfo,kubeletVersion},os_image:{status,nodeInfo,osImage},provider_id:{spec,providerID},version:{spec,version}}
 type Machine struct {
-	metav1.TypeMeta   `json:",inline"`
+	metav1.TypeMeta `json:",inline"`
+	// +Metrics:gauge:name="created",JSONPath={"creationTimestamp"},help="Unix creation timestamp."
+	// +Metrics:info:name="annotation_paused",JSONPath={"annotations","cluster.x-k8s.io/paused"},help="Whether the machine is paused and any of its resources will not be processed by the controllers.",labelsFromPath={paused_value:{}}
+	// +Metrics:info:name="owner",JSONPath={"ownerReferences"},help="Owner references.",labelsFromPath={owner_is_controller:{controller},owner_kind:{kind},owner_name:{name},owner_uid:{uid}}
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	Spec   MachineSpec   `json:"spec,omitempty"`

api/v1beta1/machinedeployment_types.go

@@ -97,6 +97,7 @@ type MachineDeploymentSpec struct {
 	// * An existing MachineDeployment which initially wasn't controlled by the autoscaler
 	//   should be later controlled by the autoscaler
 	// +optional
+	// +Metrics:gauge:name="spec_replicas",help="The number of desired machines for a machinedeployment."
 	Replicas *int32 `json:"replicas,omitempty"`
 
 	// RolloutAfter is a field to indicate a rollout should be performed
@@ -134,6 +135,7 @@ type MachineDeploymentSpec struct {
 
 	// Indicates that the deployment is paused.
 	// +optional
+	// +Metrics:gauge:name="spec_paused",help="Whether the machinedeployment is paused and any of its resources will not be processed by the controllers.",nilIsZero=true
 	Paused bool `json:"paused,omitempty"`
 
 	// The maximum time in seconds for a deployment to make progress before it
@@ -183,6 +185,7 @@ type MachineRollingUpdateDeployment struct {
 	// that the total number of machines available at all times
 	// during the update is at least 70% of desired machines.
 	// +optional
+	// +Metrics:gauge:name="spec_strategy_rollingupdate_max_unavailable",help="Maximum number of unavailable replicas during a rolling update of a machinedeployment."
 	MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`
 
 	// The maximum number of machines that can be scheduled above the
@@ -199,6 +202,7 @@ type MachineRollingUpdateDeployment struct {
 	// be scaled up further, ensuring that total number of machines running
 	// at any time during the update is at most 130% of desired machines.
 	// +optional
+	// +Metrics:gauge:name="spec_strategy_rollingupdate_max_surge",help="Maximum number of replicas that can be scheduled above the desired number of replicas during a rolling update of a machinedeployment."
 	MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty"`
 
 	// DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling.
@@ -228,20 +232,24 @@ type MachineDeploymentStatus struct {
 	// Total number of non-terminated machines targeted by this deployment
 	// (their labels match the selector).
 	// +optional
+	// +Metrics:gauge:name="status_replicas",help="The number of replicas per machinedeployment.",nilIsZero=true
 	Replicas int32 `json:"replicas"`
 
 	// Total number of non-terminated machines targeted by this deployment
 	// that have the desired template spec.
 	// +optional
+	// +Metrics:gauge:name="status_replicas_updated",help="The number of updated replicas per machinedeployment.",nilIsZero=true
 	UpdatedReplicas int32 `json:"updatedReplicas"`
 
 	// Total number of ready machines targeted by this deployment.
 	// +optional
+	// +Metrics:gauge:name="status_ready_replicas",help="The number of ready replicas per machinedeployment.",nilIsZero=true
 	ReadyReplicas int32 `json:"readyReplicas"`
 
 	// Total number of available machines (ready for at least minReadySeconds)
 	// targeted by this deployment.
 	// +optional
+	// +Metrics:gauge:name="status_replicas_available",help="The number of available replicas per machinedeployment.",nilIsZero=true
 	AvailableReplicas int32 `json:"availableReplicas"`
 
 	// Total number of unavailable machines targeted by this deployment.
@@ -250,14 +258,17 @@ type MachineDeploymentStatus struct {
 	// be machines that are running but not yet available or machines
 	// that still have not been created.
 	// +optional
+	// +Metrics:gauge:name="status_replicas_unavailable",help="The number of unavailable replicas per machinedeployment.",nilIsZero=true
 	UnavailableReplicas int32 `json:"unavailableReplicas"`
 
 	// Phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown).
 	// +optional
+	// +Metrics:stateset:name="status_phase",help="The machinedeployments current phase.",labelName="phase",list={"ScalingUp","ScalingDown","Running","Failed","Unknown"}
 	Phase string `json:"phase,omitempty"`
 
 	// Conditions defines current service state of the MachineDeployment.
 	// +optional
+	// +Metrics:stateset:name="status_condition",help="The condition of a machinedeployment.",labelName="status",JSONPath={"status"},list={"True","False","Unknown"},labelsFromPath={"type":{"type"}}
 	Conditions Conditions `json:"conditions,omitempty"`
 }
 
@@ -319,8 +330,16 @@ 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:labelFromPath:name="name",JSONPath={"metadata","name"}
+// +Metrics:labelFromPath:name="namespace",JSONPath={"metadata","namespace"}
+// +Metrics:labelFromPath:name="uid",JSONPath={"metadata","uid"}
+// +Metrics:labelFromPath:name="cluster_name",JSONPath={"spec","clusterName"}
 type MachineDeployment struct {
-	metav1.TypeMeta   `json:",inline"`
+	metav1.TypeMeta `json:",inline"`
+	// +Metrics:gauge:name="created",JSONPath={"creationTimestamp"},help="Unix creation timestamp."
+	// +Metrics:info:name="annotation_paused",JSONPath={"annotations","cluster.x-k8s.io/paused"},help="Whether the machinedeployment is paused and any of its resources will not be processed by the controllers.",labelsFromPath={paused_value:{}}
+	// +Metrics:info:name="owner",JSONPath={"ownerReferences"},help="Owner references.",labelsFromPath={owner_is_controller:{controller},owner_kind:{kind},owner_name:{name},owner_uid:{uid}}
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	Spec   MachineDeploymentSpec   `json:"spec,omitempty"`

api/v1beta1/machinehealthcheck_types.go

@@ -109,17 +109,20 @@ type MachineHealthCheckStatus struct {
 	// total number of machines counted by this machine health check
 	// +kubebuilder:validation:Minimum=0
 	// +optional
+	// +Metrics:gauge:name="status_expected_machines",help="Total number of machines counted by this machinehealthcheck.",nilIsZero=true
 	ExpectedMachines int32 `json:"expectedMachines"`
 
 	// total number of healthy machines counted by this machine health check
 	// +kubebuilder:validation:Minimum=0
 	// +optional
+	// +Metrics:gauge:name="status_current_healthy",help="Current number of healthy machines.",nilIsZero=true
 	CurrentHealthy int32 `json:"currentHealthy"`
 
 	// RemediationsAllowed is the number of further remediations allowed by this machine health check before
 	// maxUnhealthy short circuiting will be applied
 	// +kubebuilder:validation:Minimum=0
 	// +optional
+	// +Metrics:gauge:name="status_remediations_allowed",help="Number of machine remediations that are currently allowed.",nilIsZero=true
 	RemediationsAllowed int32 `json:"remediationsAllowed"`
 
 	// ObservedGeneration is the latest generation observed by the controller.
@@ -132,6 +135,7 @@ type MachineHealthCheckStatus struct {
 
 	// Conditions defines current service state of the MachineHealthCheck.
 	// +optional
+	// +Metrics:stateset:name="status_condition",help="The condition of a machinehealthcheck.",labelName="status",JSONPath={"status"},list={"True","False","Unknown"},labelsFromPath={"type":{"type"}}
 	Conditions Conditions `json:"conditions,omitempty"`
 }
 
@@ -148,8 +152,16 @@ 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:labelFromPath:name="name",JSONPath={"metadata","name"}
+// +Metrics:labelFromPath:name="namespace",JSONPath={"metadata","namespace"}
+// +Metrics:labelFromPath:name="uid",JSONPath={"metadata","uid"}
+// +Metrics:labelFromPath:name="cluster_name",JSONPath={"spec","clusterName"}
 type MachineHealthCheck struct {
-	metav1.TypeMeta   `json:",inline"`
+	metav1.TypeMeta `json:",inline"`
+	// +Metrics:gauge:name="created",JSONPath={"creationTimestamp"},help="Unix creation timestamp."
+	// +Metrics:info:name="annotation_paused",JSONPath={"annotations","cluster.x-k8s.io/paused"},help="Whether the machinehealthcheck is paused and any of its resources will not be processed by the controllers.",labelsFromPath={paused_value:{}}
+	// +Metrics:info:name="owner",JSONPath={"ownerReferences"},help="Owner references.",labelsFromPath={owner_is_controller:{controller},owner_kind:{kind},owner_name:{name},owner_uid:{uid}}
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// Specification of machine health check policy

api/v1beta1/machineset_types.go

@@ -44,6 +44,7 @@ type MachineSetSpec struct {
 	// Defaults to 1.
 	// +optional
 	// +kubebuilder:default=1
+	// +Metrics:gauge:name="spec_replicas",help="The number of desired machines for a machineset.",nilIsZero=true
 	Replicas *int32 `json:"replicas,omitempty"`
 
 	// MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available.
@@ -128,18 +129,22 @@ type MachineSetStatus struct {
 
 	// Replicas is the most recently observed number of replicas.
 	// +optional
+	// +Metrics:gauge:name="status_replicas",help="The number of replicas per machineset.",nilIsZero=true
 	Replicas int32 `json:"replicas"`
 
 	// The number of replicas that have labels matching the labels of the machine template of the MachineSet.
 	// +optional
+	// +Metrics:gauge:name="status_fully_labeled_replicas",help="The number of fully labeled replicas per machineset.",nilIsZero=true
 	FullyLabeledReplicas int32 `json:"fullyLabeledReplicas"`
 
 	// The number of ready replicas for this MachineSet. A machine is considered ready when the node has been created and is "Ready".
 	// +optional
+	// +Metrics:gauge:name="status_ready_replicas",help="The number of ready replicas per machineset.",nilIsZero=true
 	ReadyReplicas int32 `json:"readyReplicas"`
 
 	// The number of available replicas (ready for at least minReadySeconds) for this MachineSet.
 	// +optional
+	// +Metrics:gauge:name="status_available_replicas",help="The number of available replicas per machineset.",nilIsZero=true
 	AvailableReplicas int32 `json:"availableReplicas"`
 
 	// ObservedGeneration reflects the generation of the most recently observed MachineSet.
@@ -170,6 +175,7 @@ type MachineSetStatus struct {
 	FailureMessage *string `json:"failureMessage,omitempty"`
 	// Conditions defines current service state of the MachineSet.
 	// +optional
+	// +Metrics:stateset:name="status_condition",help="The condition of a machineset.",labelName="status",JSONPath={"status"},list={"True","False","Unknown"},labelsFromPath={"type":{"type"}}
 	Conditions Conditions `json:"conditions,omitempty"`
 }
 
@@ -212,8 +218,16 @@ 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:labelFromPath:name="name",JSONPath={"metadata","name"}
+// +Metrics:labelFromPath:name="namespace",JSONPath={"metadata","namespace"}
+// +Metrics:labelFromPath:name="uid",JSONPath={"metadata","uid"}
+// +Metrics:labelFromPath:name="cluster_name",JSONPath={"spec","clusterName"}
 type MachineSet struct {
-	metav1.TypeMeta   `json:",inline"`
+	metav1.TypeMeta `json:",inline"`
+	// +Metrics:gauge:name="created",JSONPath={"creationTimestamp"},help="Unix creation timestamp."
+	// +Metrics:info:name="annotation_paused",JSONPath={"annotations","cluster.x-k8s.io/paused"},help="Whether the machineset is paused and any of its resources will not be processed by the controllers.",labelsFromPath={paused_value:{}}
+	// +Metrics:info:name="owner",JSONPath={"ownerReferences"},help="Owner references.",labelsFromPath={owner_is_controller:{controller},owner_kind:{kind},owner_name:{name},owner_uid:{uid}}
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	Spec   MachineSetSpec   `json:"spec,omitempty"`

controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go

@@ -76,6 +76,7 @@ type KubeadmControlPlaneSpec struct {
 	// odd numbers are permitted, as per [etcd best practice](https://etcd.io/docs/v3.3.12/faq/#why-an-odd-number-of-cluster-members).
 	// This is a pointer to distinguish between explicit zero and not specified.
 	// +optional
+	// +Metrics:gauge:name="spec_replicas",help="The number of desired machines for a kubeadmcontrolplane."
 	Replicas *int32 `json:"replicas,omitempty"`
 
 	// Version defines the desired Kubernetes version.
@@ -181,6 +182,7 @@ type RollingUpdate struct {
 	// Example: when this is set to 1, the control plane can be scaled
 	// up immediately when the rolling update starts.
 	// +optional
+	// +Metrics:gauge:name="spec_strategy_rollingupdate_max_surge",help="Maximum number of replicas that can be scheduled above the desired number of replicas during a rolling update of a kubeadmcontrolplane."
 	MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty"`
 }
 
@@ -241,6 +243,7 @@ type KubeadmControlPlaneStatus struct {
 	// Total number of non-terminated machines targeted by this control plane
 	// (their labels match the selector).
 	// +optional
+	// +Metrics:gauge:name="status_replicas",help="The number of replicas per kubeadmcontrolplane.",nilIsZero=true
 	Replicas int32 `json:"replicas"`
 
 	// Version represents the minimum Kubernetes version for the control plane machines
@@ -251,10 +254,12 @@ type KubeadmControlPlaneStatus struct {
 	// Total number of non-terminated machines targeted by this control plane
 	// that have the desired template spec.
 	// +optional
+	// +Metrics:gauge:name="status_replicas_updated",help="The number of updated replicas per kubeadmcontrolplane.",nilIsZero=true
 	UpdatedReplicas int32 `json:"updatedReplicas"`
 
 	// Total number of fully running and ready control plane machines.
 	// +optional
+	// +Metrics:gauge:name="status_ready_replicas",help="The number of ready replicas per kubeadmcontrolplane.",nilIsZero=true
 	ReadyReplicas int32 `json:"readyReplicas"`
 
 	// Total number of unavailable machines targeted by this control plane.
@@ -263,6 +268,7 @@ type KubeadmControlPlaneStatus struct {
 	// be machines that are running but not yet ready or machines
 	// that still have not been created.
 	// +optional
+	// +Metrics:gauge:name="status_replicas_unavailable",help="The number of unavailable replicas per kubeadmcontrolplane.",nilIsZero=true
 	UnavailableReplicas int32 `json:"unavailableReplicas"`
 
 	// Initialized denotes whether or not the control plane has the
@@ -292,6 +298,7 @@ type KubeadmControlPlaneStatus struct {
 
 	// Conditions defines current service state of the KubeadmControlPlane.
 	// +optional
+	// +Metrics:stateset:name="status_condition",help="The condition of a kubeadmcontrolplane.",labelName="status",JSONPath={"status"},list={"True","False","Unknown"},labelsFromPath={"type":{"type"}}
 	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
 
 	// LastRemediation stores info about last remediation performed.
@@ -331,8 +338,18 @@ 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:labelFromPath:name="name",JSONPath={"metadata","name"}
+// +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}
+// +Metrics:labelFromPath:name="uid",JSONPath={metadata,uid}
+// +Metrics:info:name="info",help="Information about a kubeadmcontrolplane.",labelsFromPath={version:{"spec","version"}}
 type KubeadmControlPlane struct {
-	metav1.TypeMeta   `json:",inline"`
+	metav1.TypeMeta `json:",inline"`
+	// +Metrics:info:name="annotation_paused",JSONPath={"annotations","cluster.x-k8s.io/paused"},help="Whether the kubeadmcontrolplane is paused and any of its resources will not be processed by the controllers.",labelsFromPath={paused_value:{}}
+	// +Metrics:gauge:name="created",JSONPath={"creationTimestamp"},help="Unix creation timestamp."
+	// +Metrics:info:name="owner",JSONPath={"ownerReferences"},help="Owner references.",labelsFromPath={owner_is_controller:{controller},owner_kind:{kind},owner_name:{name},owner_uid:{uid}}
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	Spec   KubeadmControlPlaneSpec   `json:"spec,omitempty"`