Skip to content

feat(metrics): add machine deployment metrics #1879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cmd/machine-controller/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,9 @@ func (bs *controllerBootstrap) Start(ctx context.Context) error {
machineCollector := machinecontroller.NewMachineCollector(ctx, bs.mgr.GetClient())
metrics.Registry.MustRegister(machineCollector)

machineDeploymentCollector := machinedeploymentcontroller.NewCollector(ctx, bs.mgr.GetClient())
metrics.Registry.MustRegister(machineDeploymentCollector)

if err := machinecontroller.Add(
ctx,
bs.opt.log,
Expand Down
7 changes: 0 additions & 7 deletions pkg/cloudprovider/provider/anexia/types/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ package types
import (
"time"

"k8c.io/machine-controller/pkg/apis/cluster/common"
cloudprovidererrors "k8c.io/machine-controller/pkg/cloudprovider/errors"
"k8c.io/machine-controller/pkg/jsonutil"
providerconfigtypes "k8c.io/machine-controller/pkg/providerconfig/types"

Expand All @@ -42,11 +40,6 @@ const (
MachinePoweredOn = "poweredOn"
)

var StatusUpdateFailed = cloudprovidererrors.TerminalError{
Reason: common.UpdateMachineError,
Message: "Failed to update the machine status",
}

// RawDisk specifies a single disk, with some values maybe being fetched from secrets.
type RawDisk struct {
Size int `json:"size"`
Expand Down
112 changes: 112 additions & 0 deletions pkg/controller/machinedeployment/metrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
/*
Copyright 2025 The Machine Controller Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package machinedeployment

import (
"context"

"github.com/prometheus/client_golang/prometheus"
"k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
)

const metricsPrefix = "machine_deployment_"

type Collector struct {
ctx context.Context
client ctrlruntimeclient.Client

replicas *prometheus.Desc
availableReplicas *prometheus.Desc
readyReplicas *prometheus.Desc
updatedReplicas *prometheus.Desc
}

// NewCollector creates new machine deployment collector for metrics collection.
func NewCollector(ctx context.Context, client ctrlruntimeclient.Client) *Collector {
return &Collector{
ctx: ctx,
client: client,
replicas: prometheus.NewDesc(
metricsPrefix+"replicas",
"The number of replicas defined for a machine deployment",
[]string{"name", "namespace"}, nil,
),
availableReplicas: prometheus.NewDesc(
metricsPrefix+"available_replicas",
"The number of available replicas for a machine deployment",
[]string{"name", "namespace"}, nil,
),
readyReplicas: prometheus.NewDesc(
metricsPrefix+"ready_replicas",
"The number of ready replicas for a machine deployment",
[]string{"name", "namespace"}, nil,
),
updatedReplicas: prometheus.NewDesc(
metricsPrefix+"updated_replicas",
"The number of replicas updated for a machine deployment",
[]string{"name", "namespace"}, nil,
),
}
}

// Describe implements the prometheus.Describe interface.
func (c *Collector) Describe(desc chan<- *prometheus.Desc) {
desc <- c.replicas
desc <- c.readyReplicas
desc <- c.availableReplicas
desc <- c.readyReplicas
}

// Collect implements the prometheus.Collector interface.
func (c *Collector) Collect(metrics chan<- prometheus.Metric) {
machineDeployments := &v1alpha1.MachineDeploymentList{}
if err := c.client.List(c.ctx, machineDeployments); err != nil {
return
}

for _, machineDeployment := range machineDeployments.Items {
metrics <- prometheus.MustNewConstMetric(
c.replicas,
prometheus.GaugeValue,
float64(machineDeployment.Status.Replicas),
machineDeployment.Name,
machineDeployment.Namespace,
)
metrics <- prometheus.MustNewConstMetric(
c.readyReplicas,
prometheus.GaugeValue,
float64(machineDeployment.Status.ReadyReplicas),
machineDeployment.Name,
machineDeployment.Namespace,
)
metrics <- prometheus.MustNewConstMetric(
c.availableReplicas,
prometheus.GaugeValue,
float64(machineDeployment.Status.AvailableReplicas),
machineDeployment.Name,
machineDeployment.Namespace,
)
metrics <- prometheus.MustNewConstMetric(
c.updatedReplicas,
prometheus.GaugeValue,
float64(machineDeployment.Status.UpdatedReplicas),
machineDeployment.Name,
machineDeployment.Namespace,
)
}
}