helm-external-secrets/pkg/controllers/secretstore/cssmetrics/cssmetrics.go

/*
Copyright © 2025 ESO Maintainer Team

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

    https://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 cssmetrics provides metrics for ClusterSecretStore controllers.
package cssmetrics

import (
	"github.com/prometheus/client_golang/prometheus"
	"sigs.k8s.io/controller-runtime/pkg/metrics"

	ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
	commonmetrics "github.com/external-secrets/external-secrets/pkg/controllers/secretstore/metrics"
)

const (
	// ClusterSecretStoreSubsystem is the subsystem name for ClusterSecretStore metrics.
	ClusterSecretStoreSubsystem = "clustersecretstore"

	// ClusterSecretStoreReconcileDurationKey is the key for the reconcile duration metric.
	ClusterSecretStoreReconcileDurationKey = "reconcile_duration"
)

var gaugeVecMetrics = map[string]*prometheus.GaugeVec{}

// SetUpMetrics is called at the root to set-up the metric logic using the
// config flags provided.
func SetUpMetrics() {
	clusterSecretStoreReconcileDuration := prometheus.NewGaugeVec(prometheus.GaugeOpts{
		Subsystem: ClusterSecretStoreSubsystem,
		Name:      ClusterSecretStoreReconcileDurationKey,
		Help:      "The duration time to reconcile the Cluster Secret Store",
	}, ctrlmetrics.NonConditionMetricLabelNames)

	clusterSecretStoreCondition := prometheus.NewGaugeVec(prometheus.GaugeOpts{
		Subsystem: ClusterSecretStoreSubsystem,
		Name:      commonmetrics.StatusConditionKey,
		Help:      "The status condition of a specific Cluster Secret Store",
	}, ctrlmetrics.ConditionMetricLabelNames)

	metrics.Registry.MustRegister(clusterSecretStoreReconcileDuration, clusterSecretStoreCondition)

	gaugeVecMetrics = map[string]*prometheus.GaugeVec{
		ClusterSecretStoreReconcileDurationKey: clusterSecretStoreReconcileDuration,
		commonmetrics.StatusConditionKey:       clusterSecretStoreCondition,
	}
}

// GetGaugeVec retrieves a Prometheus GaugeVec based on the provided key.
func GetGaugeVec(key string) *prometheus.GaugeVec {
	return gaugeVecMetrics[key]
}

// RemoveMetrics deletes all metrics published by the resource.
func RemoveMetrics(namespace, name string) {
	for _, gaugeVecMetric := range gaugeVecMetrics {
		gaugeVecMetric.DeletePartialMatch(
			map[string]string{
				"namespace": namespace,
				"name":      name,
			},
		)
	}
}