capsule/pkg/metrics/claim_recorder.go

// Copyright 2020-2025 Project Capsule Authors
// SPDX-License-Identifier: Apache-2.0

package metrics

import (
	"github.com/prometheus/client_golang/prometheus"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	crtlmetrics "sigs.k8s.io/controller-runtime/pkg/metrics"

	capsulev1beta2 "github.com/projectcapsule/capsule/api/v1beta2"
)

type ClaimRecorder struct {
	claimConditionGauge *prometheus.GaugeVec
	claimResourcesGauge *prometheus.GaugeVec
}

func MustMakeClaimRecorder() *ClaimRecorder {
	metricsRecorder := NewClaimRecorder()
	crtlmetrics.Registry.MustRegister(metricsRecorder.Collectors()...)

	return metricsRecorder
}

func NewClaimRecorder() *ClaimRecorder {
	return &ClaimRecorder{
		claimConditionGauge: prometheus.NewGaugeVec(
			prometheus.GaugeOpts{
				Namespace: metricsPrefix,
				Name:      "claim_condition",
				Help:      "The current condition status of a claim.",
			},
			[]string{"name", "target_namespace", "condition", "reason", "pool"},
		),
		claimResourcesGauge: prometheus.NewGaugeVec(
			prometheus.GaugeOpts{
				Namespace: metricsPrefix,
				Name:      "claim_resource",
				Help:      "The given amount of resources from the claim",
			},
			[]string{"name", "target_namespace", "resource"},
		),
	}
}

func (r *ClaimRecorder) Collectors() []prometheus.Collector {
	return []prometheus.Collector{
		r.claimConditionGauge,
		r.claimResourcesGauge,
	}
}

// RecordCondition records the condition as given for the ref.
func (r *ClaimRecorder) RecordClaimCondition(claim *capsulev1beta2.ResourcePoolClaim) {
	// Remove all Condition Metrics to avoid duplicates
	r.claimConditionGauge.DeletePartialMatch(map[string]string{
		"name":      claim.Name,
		"namespace": claim.Namespace,
	})

	value := 0
	if claim.Status.Condition.Status == metav1.ConditionTrue {
		value = 1
	}

	r.claimConditionGauge.WithLabelValues(
		claim.Name,
		claim.Namespace,
		claim.Status.Condition.Type,
		claim.Status.Condition.Reason,
		claim.Status.Pool.Name.String(),
	).Set(float64(value))

	for resourceName, qt := range claim.Spec.ResourceClaims {
		r.claimResourcesGauge.WithLabelValues(
			claim.Name,
			claim.Namespace,
			resourceName.String(),
		).Set(float64(qt.MilliValue()) / 1000)
	}
}

// DeleteCondition deletes the condition metrics for the ref.
func (r *ClaimRecorder) DeleteClaimMetric(claim string, namespace string) {
	r.claimConditionGauge.DeletePartialMatch(map[string]string{
		"name":      claim,
		"namespace": namespace,
	})
	r.claimResourcesGauge.DeletePartialMatch(map[string]string{
		"name":      claim,
		"namespace": namespace,
	})
}