WIP: add reconcile metrics

Signed-off-by: Alexander Greene <[email protected]>

Author: awgreene

cmd/olm/manager.go

@@ -16,6 +16,7 @@ import (
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/feature"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
 )
 
 var (
@@ -28,6 +29,9 @@ func init() {
 		panic(err)
 	}
 	copiedLabelDoesNotExist = labels.NewSelector().Add(*requirement)
+
+	// Register metrics
+	metrics.RegisterReconcileMetrics()
 }
 
 func Manager(ctx context.Context, debug bool) (ctrl.Manager, error) {

pkg/controller/operators/adoption_controller.go

@@ -30,6 +30,7 @@ import (
 	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/decorators"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
 )
 
 // AdoptionReconciler automagically associates Operator components with their respective operator resource.
@@ -47,6 +48,7 @@ type AdoptionReconciler struct {
 
 // SetupWithManager adds the operator reconciler to the given controller manager.
 func (r *AdoptionReconciler) SetupWithManager(mgr ctrl.Manager) error {
+	metrics.EmitAdoptionReconcile()
 	// Trigger operator events from the events of their compoenents.
 	enqueueSub := handler.EnqueueRequestsFromMapFunc(r.mapToSubscriptions)
 

pkg/controller/operators/operator_controller.go

@@ -28,6 +28,7 @@ import (
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/decorators"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
 )
 
 var (
@@ -115,6 +116,7 @@ func NewOperatorReconciler(cli client.Client, log logr.Logger, scheme *runtime.S
 var _ reconcile.Reconciler = &OperatorReconciler{}
 
 func (r *OperatorReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	metrics.EmitOperatorReconcile()
 	// Set up a convenient log object so we don't have to type request over and over again
 	log := r.log.WithValues("request", req)
 	log.V(1).Info("reconciling operator")

pkg/controller/operators/operatorcondition_controller.go

@@ -22,6 +22,7 @@ import (
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
 )
 
 const (
@@ -91,6 +92,7 @@ func NewOperatorConditionReconciler(cli client.Client, log logr.Logger, scheme *
 var _ reconcile.Reconciler = &OperatorConditionReconciler{}
 
 func (r *OperatorConditionReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	metrics.EmitOperatorConditionReconcile()
 	// Set up a convenient log object so we don't have to type request over and over again
 	log := r.log.WithValues("request", req)
 	log.V(2).Info("reconciling operatorcondition")

pkg/controller/operators/operatorconditiongenerator_controller.go

@@ -20,6 +20,7 @@ import (
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
 )
 
 // OperatorConditionGeneratorReconciler reconciles a ClusterServiceVersion object and creates an OperatorCondition.
@@ -88,6 +89,7 @@ func NewOperatorConditionGeneratorReconciler(cli client.Client, log logr.Logger,
 var _ reconcile.Reconciler = &OperatorConditionGeneratorReconciler{}
 
 func (r *OperatorConditionGeneratorReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	metrics.EmitOperatorConditionGeneratorReconcile()
 	// Set up a convenient log object so we don't have to type request over and over again
 	log := r.log.WithValues("request", req)
 

pkg/metrics/metrics.go

@@ -1,6 +1,8 @@
 package metrics
 
 import (
+	"fmt"
+	"strings"
 	"time"
 
 	"github.com/prometheus/client_golang/prometheus"
@@ -27,6 +29,12 @@ const (
 	APPROVAL_LABEL  = "approval"
 	WARNING_LABEL   = "warning"
 	GVK_LABEL       = "gvk"
+
+	// Controller names
+	operatorController                   = "operator"
+	adoptionController                   = "adoption"
+	operatorConditionController          = "operator_condition"
+	operatorConditionGeneratorController = "operator_condition_generator"
 )
 
 type MetricsProvider interface {
@@ -199,13 +207,31 @@ var (
 			Help: "monotonic count of resources that generated warnings when applied as part of an InstallPlan (for example, due to deprecation)",
 		},
 	)
+	reconcileMetrics = reconcileCounters(operatorController, adoptionController, operatorConditionController, operatorConditionGeneratorController)
 
 	// subscriptionSyncCounters keeps a record of the promethues counters emitted by
 	// Subscription objects. The key of a record is the Subscription name, while the value
 	//  is struct containing label values used in the counter
 	subscriptionSyncCounters = make(map[string]subscriptionSyncLabelValues)
 )
 
+func reconcileCounters(reconcilerNames ...string) map[string]prometheus.Counter {
+	result := map[string]prometheus.Counter{}
+	for _, s := range reconcilerNames {
+		result[s] = reconcileCounter(s)
+	}
+	return result
+}
+
+func reconcileCounter(name string) prometheus.Counter {
+	return prometheus.NewCounter(
+		prometheus.CounterOpts{
+			Name: "controller_reconcile_" + name,
+			Help: fmt.Sprintf("Count of reconcile events by the %s controller", strings.Replace(name, "_", " ", -1)),
+		},
+	)
+}
+
 type subscriptionSyncLabelValues struct {
 	installedCSV     string
 	pkg              string
@@ -230,6 +256,12 @@ func RegisterCatalog() {
 	prometheus.MustRegister(installPlanWarningCount)
 }
 
+func RegisterReconcileMetrics() {
+	for _, v := range reconcileMetrics {
+		prometheus.MustRegister(v)
+	}
+}
+
 func CounterForSubscription(name, installedCSV, channelName, packageName, planApprovalStrategy string) prometheus.Counter {
 	return SubscriptionSyncCount.WithLabelValues(name, installedCSV, channelName, packageName, planApprovalStrategy)
 }
@@ -334,3 +366,23 @@ func RegisterDependencyResolutionFailure(duration time.Duration) {
 func EmitInstallPlanWarning() {
 	installPlanWarningCount.Inc()
 }
+
+func EmitOperatorReconcile() {
+	emitReconcile(operatorConditionController)
+}
+func EmitAdoptionReconcile() {
+	emitReconcile(adoptionController)
+}
+func EmitOperatorConditionReconcile() {
+	emitReconcile(operatorConditionController)
+}
+
+func EmitOperatorConditionGeneratorReconcile() {
+	emitReconcile(operatorConditionGeneratorController)
+}
+
+func emitReconcile(name string) {
+	if counter, ok := reconcileMetrics[name]; ok {
+		counter.Inc()
+	}
+}