Refactor Prometheus recorder

- add flagger_info gauge metric
- expose the version and mesh provider as labels
- move the recorder to the metrics package

pkg/controller/controller.go

@@ -2,6 +2,7 @@ package controller
 
 import (
 	"fmt"
+	"github.com/weaveworks/flagger/pkg/metrics"
 	"sync"
 	"time"
 
@@ -42,7 +43,7 @@ type Controller struct {
 	jobs          map[string]CanaryJob
 	deployer      CanaryDeployer
 	observer      CanaryObserver
-	recorder      CanaryRecorder
+	recorder      metrics.CanaryRecorder
 	notifier      *notifier.Slack
 	meshProvider  string
 }
@@ -57,7 +58,7 @@ func NewController(
 	logger *zap.SugaredLogger,
 	notifier *notifier.Slack,
 	meshProvider string,
-
+	version string,
 ) *Controller {
 	logger.Debug("Creating event broadcaster")
 	flaggerscheme.AddToScheme(scheme.Scheme)
@@ -84,7 +85,8 @@ func NewController(
 		metricsServer: metricServer,
 	}
 
-	recorder := NewCanaryRecorder(true)
+	recorder := metrics.NewCanaryRecorder(controllerAgentName, true)
+	recorder.SetInfo(version, meshProvider)
 
 	ctrl := &Controller{
 		kubeClient:    kubeClient,

pkg/controller/controller_test.go

@@ -8,6 +8,7 @@ import (
 	fakeFlagger "github.com/weaveworks/flagger/pkg/client/clientset/versioned/fake"
 	informers "github.com/weaveworks/flagger/pkg/client/informers/externalversions"
 	"github.com/weaveworks/flagger/pkg/logging"
+	"github.com/weaveworks/flagger/pkg/metrics"
 	"github.com/weaveworks/flagger/pkg/router"
 	"go.uber.org/zap"
 	appsv1 "k8s.io/api/apps/v1"
@@ -94,7 +95,7 @@ func SetupMocks(abtest bool) Mocks {
 		flaggerWindow: time.Second,
 		deployer:      deployer,
 		observer:      observer,
-		recorder:      NewCanaryRecorder(false),
+		recorder:      metrics.NewCanaryRecorder(controllerAgentName, false),
 	}
 	ctrl.flaggerSynced = alwaysReady
 

pkg/controller/recorder.go

@@ -1,90 +0,0 @@
-package controller
-
-import (
-	"fmt"
-	"time"
-
-	"github.com/prometheus/client_golang/prometheus"
-	flaggerv1 "github.com/weaveworks/flagger/pkg/apis/flagger/v1alpha3"
-)
-
-// CanaryRecorder records the canary analysis as Prometheus metrics
-type CanaryRecorder struct {
-	duration *prometheus.HistogramVec
-	total    *prometheus.GaugeVec
-	status   *prometheus.GaugeVec
-	weight   *prometheus.GaugeVec
-}
-
-// NewCanaryRecorder creates a new recorder and registers the Prometheus metrics
-func NewCanaryRecorder(register bool) CanaryRecorder {
-	duration := prometheus.NewHistogramVec(prometheus.HistogramOpts{
-		Subsystem: controllerAgentName,
-		Name:      "canary_duration_seconds",
-		Help:      "Seconds spent performing canary analysis.",
-		Buckets:   prometheus.DefBuckets,
-	}, []string{"name", "namespace"})
-
-	total := prometheus.NewGaugeVec(prometheus.GaugeOpts{
-		Subsystem: controllerAgentName,
-		Name:      "canary_total",
-		Help:      "Total number of canary object",
-	}, []string{"namespace"})
-
-	// 0 - running, 1 - successful, 2 - failed
-	status := prometheus.NewGaugeVec(prometheus.GaugeOpts{
-		Subsystem: controllerAgentName,
-		Name:      "canary_status",
-		Help:      "Last canary analysis result",
-	}, []string{"name", "namespace"})
-
-	weight := prometheus.NewGaugeVec(prometheus.GaugeOpts{
-		Subsystem: controllerAgentName,
-		Name:      "canary_weight",
-		Help:      "The virtual service destination weight current value",
-	}, []string{"workload", "namespace"})
-
-	if register {
-		prometheus.MustRegister(duration)
-		prometheus.MustRegister(total)
-		prometheus.MustRegister(status)
-		prometheus.MustRegister(weight)
-	}
-
-	return CanaryRecorder{
-		duration: duration,
-		total:    total,
-		status:   status,
-		weight:   weight,
-	}
-}
-
-// SetDuration sets the time spent in seconds performing canary analysis
-func (cr *CanaryRecorder) SetDuration(cd *flaggerv1.Canary, duration time.Duration) {
-	cr.duration.WithLabelValues(cd.Spec.TargetRef.Name, cd.Namespace).Observe(duration.Seconds())
-}
-
-// SetTotal sets the total number of canaries per namespace
-func (cr *CanaryRecorder) SetTotal(namespace string, total int) {
-	cr.total.WithLabelValues(namespace).Set(float64(total))
-}
-
-// SetStatus sets the last known canary analysis status
-func (cr *CanaryRecorder) SetStatus(cd *flaggerv1.Canary, phase flaggerv1.CanaryPhase) {
-	status := 1
-	switch phase {
-	case flaggerv1.CanaryProgressing:
-		status = 0
-	case flaggerv1.CanaryFailed:
-		status = 2
-	default:
-		status = 1
-	}
-	cr.status.WithLabelValues(cd.Spec.TargetRef.Name, cd.Namespace).Set(float64(status))
-}
-
-// SetWeight sets the weight values for primary and canary destinations
-func (cr *CanaryRecorder) SetWeight(cd *flaggerv1.Canary, primary int, canary int) {
-	cr.weight.WithLabelValues(fmt.Sprintf("%s-primary", cd.Spec.TargetRef.Name), cd.Namespace).Set(float64(primary))
-	cr.weight.WithLabelValues(cd.Spec.TargetRef.Name, cd.Namespace).Set(float64(canary))
-}