Skip to content

Add experimental metrics to e2e runs #2435

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
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ SHELL := /bin/bash
ORG := github.com/operator-framework
PKG := $(ORG)/operator-lifecycle-manager
MOD_FLAGS := $(shell (go version | grep -q -E "1\.1[1-9]") && echo -mod=vendor)
BUILD_TAGS := "json1"
CMDS := $(shell go list $(MOD_FLAGS) ./cmd/...)
TCMDS := $(shell go list $(MOD_FLAGS) ./test/e2e/...)
MOCKGEN := ./scripts/update_mockgen.sh
Expand Down Expand Up @@ -101,7 +102,7 @@ bin/cpb: FORCE

$(CMDS): version_flags=-ldflags "-X $(PKG)/pkg/version.GitCommit=$(GIT_COMMIT) -X $(PKG)/pkg/version.OLMVersion=`cat OLM_VERSION`"
$(CMDS):
$(arch_flags) go $(build_cmd) $(MOD_FLAGS) $(version_flags) -tags "json1" -o bin/$(shell basename $@) $@
$(arch_flags) go $(build_cmd) $(MOD_FLAGS) $(version_flags) -tags $(BUILD_TAGS) -o bin/$(shell basename $@) $@

build: clean $(CMDS)

Expand Down Expand Up @@ -143,6 +144,7 @@ e2e:

# See workflows/e2e-tests.yml See test/e2e/README.md for details.
.PHONY: e2e-local
e2e-local: BUILD_TAGS="json1 experimental_metrics"
e2e-local: extra_args=-kind.images=../test/e2e-local.image.tar
e2e-local: run=bin/e2e-local.test
e2e-local: bin/e2e-local.test test/e2e-local.image.tar
Expand Down
3 changes: 3 additions & 0 deletions pkg/controller/operators/adoption_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -113,6 +114,7 @@ func (r *AdoptionReconciler) ReconcileSubscription(ctx context.Context, req ctrl
// 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 subscription")
metrics.EmitAdoptionSubscriptionReconcile(req.Namespace, req.Name)

// Fetch the Subscription from the cache
in := &operatorsv1alpha1.Subscription{}
Expand Down Expand Up @@ -175,6 +177,7 @@ func (r *AdoptionReconciler) ReconcileClusterServiceVersion(ctx context.Context,
// 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 csv")
metrics.EmitAdoptionCSVReconcile(req.Namespace, req.Name)

// Fetch the CSV from the cache
in := &operatorsv1alpha1.ClusterServiceVersion{}
Expand Down
2 changes: 2 additions & 0 deletions pkg/controller/operators/operator_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down Expand Up @@ -118,6 +119,7 @@ func (r *OperatorReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
// 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")
metrics.EmitOperatorReconcile(req.Namespace, req.Name)

// Get the Operator
create := false
Expand Down
2 changes: 2 additions & 0 deletions pkg/controller/operators/operatorcondition_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down Expand Up @@ -94,6 +95,7 @@ func (r *OperatorConditionReconciler) Reconcile(ctx context.Context, req ctrl.Re
// 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")
metrics.EmitOperatorConditionReconcile(req.Namespace, req.Name)

operatorCondition := &operatorsv2.OperatorCondition{}
err := r.Client.Get(context.TODO(), req.NamespacedName, operatorCondition)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -90,6 +91,7 @@ var _ reconcile.Reconciler = &OperatorConditionGeneratorReconciler{}
func (r *OperatorConditionGeneratorReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
// Set up a convenient log object so we don't have to type request over and over again
log := r.log.WithValues("request", req)
metrics.EmitOperatorConditionGeneratorReconcile(req.Namespace, req.Name)

in := &operatorsv1alpha1.ClusterServiceVersion{}
err := r.Client.Get(context.TODO(), req.NamespacedName, in)
Expand Down
42 changes: 42 additions & 0 deletions pkg/metrics/experimental_declarations.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package metrics

import "github.com/prometheus/client_golang/prometheus"

const (
// Controller names
operatorController = "operator"
adoptionCSVController = "adoption_csv"
adoptionSubscriptionController = "adoption_subscription"
operatorConditionController = "operator_condition"
operatorConditionGeneratorController = "operator_condition_generator"
)

var (
reconcileMetrics = map[string]*prometheus.CounterVec{}
)

func EmitOperatorReconcile(namespace, name string) {
emitReconcile(operatorController, namespace, name)
}

func EmitAdoptionCSVReconcile(namespace, name string) {
emitReconcile(adoptionCSVController, namespace, name)
}

func EmitAdoptionSubscriptionReconcile(namespace, name string) {
emitReconcile(adoptionSubscriptionController, namespace, name)
}

func EmitOperatorConditionReconcile(namespace, name string) {
emitReconcile(operatorConditionController, namespace, name)
}

func EmitOperatorConditionGeneratorReconcile(namespace, name string) {
emitReconcile(operatorConditionGeneratorController, namespace, name)
}

func emitReconcile(controllerName, namespace, name string) {
if counter, ok := reconcileMetrics[controllerName]; ok {
counter.WithLabelValues(namespace, name).Inc()
}
}
41 changes: 41 additions & 0 deletions pkg/metrics/experimental_register.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
//go:build experimental_metrics
// +build experimental_metrics

package metrics

import (
"fmt"
"strings"

"github.com/prometheus/client_golang/prometheus"
)

func init() {
// Register experimental metrics
reconcileMetrics = reconcileCounters(operatorController, adoptionCSVController, adoptionSubscriptionController, operatorConditionController, operatorConditionGeneratorController)
registerReconcileMetrics()
}

func reconcileCounters(reconcilerNames ...string) map[string]*prometheus.CounterVec {
result := map[string]*prometheus.CounterVec{}
for _, s := range reconcilerNames {
result[s] = createReconcileCounterVec(s)
}
return result
}

func createReconcileCounterVec(name string) *prometheus.CounterVec {
return prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "controller_reconcile_" + name,
Help: fmt.Sprintf("Count of reconcile events by the %s controller", strings.Replace(name, "_", " ", -1)),
},
[]string{NamespaceLabel, NameLabel},
)
}

func registerReconcileMetrics() {
for _, v := range reconcileMetrics {
prometheus.MustRegister(v)
}
}