add register parameter when register metrics

Signed-off-by: yeya24 <[email protected]>

Author: yeya24

dfdaemon/server.go

@@ -28,6 +28,7 @@ import (
 	"github.com/dragonflyoss/Dragonfly/version"
 
 	"github.com/pkg/errors"
+	"github.com/prometheus/client_golang/prometheus"
 	"github.com/sirupsen/logrus"
 )
 
@@ -83,6 +84,8 @@ func New(opts ...Option) (*Server, error) {
 		},
 		proxy: p,
 	}
+	// register dfdaemon build information
+	version.NewBuildInfo("dfdaemon", prometheus.DefaultRegisterer)
 
 	for _, opt := range opts {
 		if err := opt(s); err != nil {
@@ -121,8 +124,6 @@ func (s *Server) Start() error {
 	} else {
 		logrus.Infof("start dfdaemon http server on %s", s.server.Addr)
 	}
-	// register dfdaemon build information
-	version.NewBuildInfo("dfdaemon")
 	return s.server.ListenAndServe()
 }
 

docs/user_guide/metrics.md

@@ -12,7 +12,6 @@ This doc contains all the metrics that Dragonfly components currently support. N
 - dragonfly_supernode_peers{hostname} - dragonfly peers
 - dragonfly_supernode_tasks{taskid, cdnstatus} - dragonfly tasks
 - dragonfly_supernode_dfgettasks{taskid, callsystem} - dragonfly dfget tasks
-- dragonfly_supernode_daemon_dfgettasks{taskid, callsystem} - dragonfly current dfget tasks, which are called from dfdaemon
 - dragonfly_supernode_schedule_duration_milliseconds{taskid} - duration for task scheduling in milliseconds
 - dragonfly_supernode_trigger_cdn_total{} - total times of triggering cdn.
 - dragonfly_supernode_trigger_cdn_failed_total{} - total failed times of triggering cdn.

docs/user_guide/monitoring.md

@@ -125,7 +125,7 @@ We provide several functions to add metrics easily. Here is an example to add a
 import "github.com/dragonflyoss/Dragonfly/pkg/util"
 
 requestCounter := util.NewCounter("supernode", "http_requests_total",
-			"Counter of HTTP requests.", []string{"code"})
+			"Counter of HTTP requests.", []string{"code"}, nil)
 requestCounter.WithLabelValues("200").Inc()
 ```
 

pkg/metricsutils/metrics_util.go

@@ -18,17 +18,19 @@ package metricsutils
 
 import (
 	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_golang/prometheus/promauto"
 )
 
 const (
 	namespace = "dragonfly"
 )
 
-// NewCounter will auto-register a Counter metric to prometheus default registry and return it.
-// TODO(yeya24): Stop using default registry, add registry as a parameter instead.
-func NewCounter(subsystem, name, help string, labels []string) *prometheus.CounterVec {
-	return promauto.NewCounterVec(
+// NewCounter will register a Counter metric to specified registry and return it.
+// If registry is not specified, it will register metric to default prometheus registry.
+func NewCounter(subsystem, name, help string, labels []string, register prometheus.Registerer) *prometheus.CounterVec {
+	if register == nil {
+		register = prometheus.DefaultRegisterer
+	}
+	m := prometheus.NewCounterVec(
 		prometheus.CounterOpts{
 			Namespace: namespace,
 			Subsystem: subsystem,
@@ -37,11 +39,17 @@ func NewCounter(subsystem, name, help string, labels []string) *prometheus.Count
 		},
 		labels,
 	)
+	register.MustRegister(m)
+	return m
 }
 
-// NewGauge will auto-register a Gauge metric to prometheus default registry and return it.
-func NewGauge(subsystem, name, help string, labels []string) *prometheus.GaugeVec {
-	return promauto.NewGaugeVec(
+// NewGauge will register a Gauge metric to specified registry and return it.
+// If registry is not specified, it will register metric to default prometheus registry.
+func NewGauge(subsystem, name, help string, labels []string, register prometheus.Registerer) *prometheus.GaugeVec {
+	if register == nil {
+		register = prometheus.DefaultRegisterer
+	}
+	m := prometheus.NewGaugeVec(
 		prometheus.GaugeOpts{
 			Namespace: namespace,
 			Subsystem: subsystem,
@@ -50,11 +58,17 @@ func NewGauge(subsystem, name, help string, labels []string) *prometheus.GaugeVe
 		},
 		labels,
 	)
+	register.MustRegister(m)
+	return m
 }
 
-// NewSummary will auto-register a Summary metric to prometheus default registry and return it.
-func NewSummary(subsystem, name, help string, labels []string, objectives map[float64]float64) *prometheus.SummaryVec {
-	return promauto.NewSummaryVec(
+// NewSummary will register a Summary metric to specified registry and return it.
+// If registry is not specified, it will register metric to default prometheus registry.
+func NewSummary(subsystem, name, help string, labels []string, objectives map[float64]float64, register prometheus.Registerer) *prometheus.SummaryVec {
+	if register == nil {
+		register = prometheus.DefaultRegisterer
+	}
+	m := prometheus.NewSummaryVec(
 		prometheus.SummaryOpts{
 			Namespace:  namespace,
 			Subsystem:  subsystem,
@@ -64,11 +78,17 @@ func NewSummary(subsystem, name, help string, labels []string, objectives map[fl
 		},
 		labels,
 	)
+	register.MustRegister(m)
+	return m
 }
 
-// NewHistogram will auto-register a Histogram metric to prometheus default registry and return it.
-func NewHistogram(subsystem, name, help string, labels []string, buckets []float64) *prometheus.HistogramVec {
-	return promauto.NewHistogramVec(
+// NewHistogram will register a Histogram metric to specified registry and return it.
+// If registry is not specified, it will register metric to default prometheus registry.
+func NewHistogram(subsystem, name, help string, labels []string, buckets []float64, register prometheus.Registerer) *prometheus.HistogramVec {
+	if register == nil {
+		register = prometheus.DefaultRegisterer
+	}
+	m := prometheus.NewHistogramVec(
 		prometheus.HistogramOpts{
 			Namespace: namespace,
 			Subsystem: subsystem,
@@ -78,4 +98,6 @@ func NewHistogram(subsystem, name, help string, labels []string, buckets []float
 		},
 		labels,
 	)
+	register.MustRegister(m)
+	return m
 }

pkg/timeutils/time_util.go

@@ -25,7 +25,7 @@ func GetCurrentTimeMillis() int64 {
 	return time.Now().UnixNano() / time.Millisecond.Nanoseconds()
 }
 
-// GetCurrentTimeMillisFloat returns the time in millis for now in float64 format.
-func GetCurrentTimeMillisFloat() float64 {
-	return float64(time.Now().UnixNano()) / float64(time.Millisecond.Nanoseconds())
+// SinceInMilliseconds gets the time since the specified start in milliseconds.
+func SinceInMilliseconds(start time.Time) float64 {
+	return float64(time.Since(start).Nanoseconds()) / float64(time.Millisecond.Nanoseconds())
 }

supernode/daemon/daemon.go

@@ -26,6 +26,7 @@ import (
 	"github.com/dragonflyoss/Dragonfly/supernode/server"
 
 	"github.com/go-openapi/strfmt"
+	"github.com/prometheus/client_golang/prometheus"
 	"github.com/sirupsen/logrus"
 )
 
@@ -47,7 +48,7 @@ func New(cfg *config.Config) (*Daemon, error) {
 		return nil, err
 	}
 
-	s, err := server.New(cfg)
+	s, err := server.New(cfg, prometheus.DefaultRegisterer)
 	if err != nil {
 		return nil, err
 	}

supernode/daemon/mgr/dfgettask/manager.go

@@ -19,13 +19,13 @@ package dfgettask
 import (
 	"context"
 	"fmt"
-	"github.com/dragonflyoss/Dragonfly/pkg/metricsutils"
-	"github.com/dragonflyoss/Dragonfly/supernode/config"
 
 	"github.com/dragonflyoss/Dragonfly/apis/types"
 	"github.com/dragonflyoss/Dragonfly/pkg/errortypes"
+	"github.com/dragonflyoss/Dragonfly/pkg/metricsutils"
 	"github.com/dragonflyoss/Dragonfly/pkg/stringutils"
 	"github.com/dragonflyoss/Dragonfly/pkg/syncmap"
+	"github.com/dragonflyoss/Dragonfly/supernode/config"
 	"github.com/dragonflyoss/Dragonfly/supernode/daemon/mgr"
 	dutil "github.com/dragonflyoss/Dragonfly/supernode/daemon/util"
 
@@ -36,17 +36,13 @@ import (
 var _ mgr.DfgetTaskMgr = &Manager{}
 
 type metrics struct {
-	dfgetTasks       *prometheus.GaugeVec
-	dfgetTasksDaemon *prometheus.GaugeVec
+	dfgetTasks *prometheus.GaugeVec
 }
 
-func newMetrics() *metrics {
+func newMetrics(register prometheus.Registerer) *metrics {
 	return &metrics{
 		dfgetTasks: metricsutils.NewGauge(config.SubsystemSupernode, "dfgettasks",
-			"The number of dfget tasks", []string{"taskid", "callsystem"}),
-
-		dfgetTasksDaemon: metricsutils.NewGauge(config.SubsystemSupernode, "daemon_dfgettasks",
-			"The number of dfget tasks from dfdaemon", []string{"taskid", "callsystem"}),
+			"The number of dfget tasks", []string{"taskid", "callsystem"}, register),
 	}
 }
 
@@ -58,11 +54,11 @@ type Manager struct {
 }
 
 // NewManager returns a new Manager.
-func NewManager() (*Manager, error) {
+func NewManager(register prometheus.Registerer) (*Manager, error) {
 	return &Manager{
 		dfgetTaskStore: dutil.NewStore(),
 		ptoc:           syncmap.NewSyncMap(),
-		metrics:        newMetrics(),
+		metrics:        newMetrics(register),
 	}, nil
 }
 
@@ -93,12 +89,7 @@ func (dtm *Manager) Add(ctx context.Context, dfgetTask *types.DfGetTask) error {
 
 	dtm.ptoc.Add(generatePeerKey(dfgetTask.PeerID, dfgetTask.TaskID), dfgetTask.CID)
 	dtm.dfgetTaskStore.Put(key, dfgetTask)
-
-	if dfgetTask.Dfdaemon {
-		dtm.metrics.dfgetTasksDaemon.WithLabelValues(dfgetTask.TaskID, dfgetTask.CallSystem).Inc()
-	} else {
-		dtm.metrics.dfgetTasks.WithLabelValues(dfgetTask.TaskID, dfgetTask.CallSystem).Inc()
-	}
+	dtm.metrics.dfgetTasks.WithLabelValues(dfgetTask.TaskID, dfgetTask.CallSystem).Inc()
 
 	return nil
 }
@@ -130,11 +121,7 @@ func (dtm *Manager) Delete(ctx context.Context, clientID, taskID string) error {
 		return err
 	}
 	dtm.ptoc.Delete(generatePeerKey(dfgetTask.PeerID, dfgetTask.TaskID))
-	if dfgetTask.Dfdaemon {
-		dtm.metrics.dfgetTasksDaemon.WithLabelValues(dfgetTask.TaskID, dfgetTask.CallSystem).Dec()
-	} else {
-		dtm.metrics.dfgetTasks.WithLabelValues(dfgetTask.TaskID, dfgetTask.CallSystem).Dec()
-	}
+	dtm.metrics.dfgetTasks.WithLabelValues(dfgetTask.TaskID, dfgetTask.CallSystem).Dec()
 	return dtm.dfgetTaskStore.Delete(key)
 }
 

supernode/daemon/mgr/dfgettask/manager_test.go

@@ -39,17 +39,9 @@ func init() {
 type DfgetTaskMgrTestSuite struct {
 }
 
-// SetUpTest does common setup in the beginning of each test.
-func (s *DfgetTaskMgrTestSuite) SetUpTest(c *check.C) {
-	// In every test, we should reset Prometheus default registry, otherwise
-	// it will panic because of duplicate metricsutils.
-	prometheus.DefaultRegisterer = prometheus.NewRegistry()
-}
-
 func (s *DfgetTaskMgrTestSuite) TestDfgetTaskAdd(c *check.C) {
-	manager, _ := NewManager()
-	dfgetNum := manager.metrics.dfgetTasks
-	dfgetDaemonNum := manager.metrics.dfgetTasksDaemon
+	manager, _ := NewManager(prometheus.NewRegistry())
+	dfgetTasks := manager.metrics.dfgetTasks
 
 	var testCases = []struct {
 		dfgetTask *types.DfGetTask
@@ -80,7 +72,7 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskAdd(c *check.C) {
 			dfgetTask: &types.DfGetTask{
 				CID:        "bar",
 				CallSystem: "bar",
-				Dfdaemon:   true,
+				Dfdaemon:   false,
 				Path:       "/peer/file/taskFileName",
 				PieceSize:  4 * 1024 * 1024,
 				TaskID:     "test2",
@@ -89,7 +81,7 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskAdd(c *check.C) {
 			Expect: &types.DfGetTask{
 				CID:        "bar",
 				CallSystem: "bar",
-				Dfdaemon:   true,
+				Dfdaemon:   false,
 				Path:       "/peer/file/taskFileName",
 				PieceSize:  4 * 1024 * 1024,
 				TaskID:     "test2",
@@ -102,24 +94,17 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskAdd(c *check.C) {
 	for _, tc := range testCases {
 		err := manager.Add(context.Background(), tc.dfgetTask)
 		c.Check(err, check.IsNil)
-		if tc.dfgetTask.Dfdaemon {
-			c.Assert(1, check.Equals,
-				int(prom_testutil.ToFloat64(
-					dfgetDaemonNum.WithLabelValues(tc.dfgetTask.TaskID, tc.dfgetTask.CallSystem))))
-		} else {
-			c.Assert(1, check.Equals,
-				int(prom_testutil.ToFloat64(
-					dfgetNum.WithLabelValues(tc.dfgetTask.TaskID, tc.dfgetTask.CallSystem))))
-		}
-
+		c.Assert(1, check.Equals,
+			int(prom_testutil.ToFloat64(
+				dfgetTasks.WithLabelValues(tc.dfgetTask.TaskID, tc.dfgetTask.CallSystem))))
 		dt, err := manager.Get(context.Background(), tc.dfgetTask.CID, tc.dfgetTask.TaskID)
 		c.Check(err, check.IsNil)
 		c.Check(dt, check.DeepEquals, tc.Expect)
 	}
 }
 
 func (s *DfgetTaskMgrTestSuite) TestDfgetTaskUpdate(c *check.C) {
-	manager, _ := NewManager()
+	manager, _ := NewManager(prometheus.NewRegistry())
 	var testCases = []struct {
 		dfgetTask  *types.DfGetTask
 		taskStatus string
@@ -151,7 +136,7 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskUpdate(c *check.C) {
 			dfgetTask: &types.DfGetTask{
 				CID:        "bar",
 				CallSystem: "bar",
-				Dfdaemon:   true,
+				Dfdaemon:   false,
 				Path:       "/peer/file/taskFileName",
 				PieceSize:  4 * 1024 * 1024,
 				TaskID:     "test2",
@@ -161,7 +146,7 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskUpdate(c *check.C) {
 			Expect: &types.DfGetTask{
 				CID:        "bar",
 				CallSystem: "bar",
-				Dfdaemon:   true,
+				Dfdaemon:   false,
 				Path:       "/peer/file/taskFileName",
 				PieceSize:  4 * 1024 * 1024,
 				TaskID:     "test2",
@@ -184,9 +169,8 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskUpdate(c *check.C) {
 }
 
 func (s *DfgetTaskMgrTestSuite) TestDfgetTaskDelete(c *check.C) {
-	manager, _ := NewManager()
-	dfgetNum := manager.metrics.dfgetTasks
-	dfgetDaemonNum := manager.metrics.dfgetTasksDaemon
+	manager, _ := NewManager(prometheus.NewRegistry())
+	dfgetTasks := manager.metrics.dfgetTasks
 
 	var testCases = []struct {
 		dfgetTask *types.DfGetTask
@@ -195,7 +179,7 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskDelete(c *check.C) {
 			dfgetTask: &types.DfGetTask{
 				CID:        "foo",
 				CallSystem: "foo",
-				Dfdaemon:   true,
+				Dfdaemon:   false,
 				Path:       "/peer/file/taskFileName",
 				PieceSize:  4 * 1024 * 1024,
 				TaskID:     "test1",
@@ -221,18 +205,11 @@ func (s *DfgetTaskMgrTestSuite) TestDfgetTaskDelete(c *check.C) {
 
 		err = manager.Delete(context.Background(), tc.dfgetTask.CID, tc.dfgetTask.TaskID)
 		c.Check(err, check.IsNil)
-		if tc.dfgetTask.Dfdaemon {
-			c.Assert(0, check.Equals,
-				int(prom_testutil.ToFloat64(
-					dfgetDaemonNum.WithLabelValues(tc.dfgetTask.TaskID, tc.dfgetTask.CallSystem))))
-		} else {
-			c.Assert(0, check.Equals,
-				int(prom_testutil.ToFloat64(
-					dfgetNum.WithLabelValues(tc.dfgetTask.TaskID, tc.dfgetTask.CallSystem))))
-		}
+		c.Assert(0, check.Equals,
+			int(prom_testutil.ToFloat64(
+				dfgetTasks.WithLabelValues(tc.dfgetTask.TaskID, tc.dfgetTask.CallSystem))))
 
 		_, err = manager.Get(context.Background(), tc.dfgetTask.CID, tc.dfgetTask.TaskID)
-		c.Check(errors.IsDataNotFound(err), check.Equals, true)
+		c.Check(errortypes.IsDataNotFound(err), check.Equals, true)
 	}
->>>>>>> 40bbeb8... add some supernode metrics
 }