prom: Remove custom registry (#3161)

This change renames namespaces and removes the `elem_id` label from all metrics. The element ID configured in the config is exposed through `scion_elem_id`. namespace renames: - `beacon_srv` -> `bs` - `border` -> `br` - `cert_srv` -> `cs` - `dispatcher` -> `disp` - `path_srv` -> `ps` - `sciond` -> `sd` fixes #3160
scionproto · Sep 18, 2019 · afb63c0 · afb63c0
1 parent fba6b8c
commit afb63c0
Show file tree

Hide file tree

Showing 36 changed files with 72 additions and 142 deletions.
diff --git a/go/beacon_srv/BUILD.bazel b/go/beacon_srv/BUILD.bazel
@@ -13,7 +13,6 @@ go_library(
         "//go/beacon_srv/internal/config:go_default_library",
         "//go/beacon_srv/internal/ifstate:go_default_library",
         "//go/beacon_srv/internal/keepalive:go_default_library",
-        "//go/beacon_srv/internal/metrics:go_default_library",
         "//go/beacon_srv/internal/onehop:go_default_library",
         "//go/beacon_srv/internal/revocation:go_default_library",
         "//go/lib/addr:go_default_library",
@@ -31,6 +30,7 @@ go_library(
         "//go/lib/keyconf:go_default_library",
         "//go/lib/log:go_default_library",
         "//go/lib/periodic:go_default_library",
+        "//go/lib/prom:go_default_library",
         "//go/lib/scrypto:go_default_library",
         "//go/lib/snet:go_default_library",
         "//go/lib/sock/reliable:go_default_library",

diff --git a/go/beacon_srv/internal/metrics/BUILD.bazel b/go/beacon_srv/internal/metrics/BUILD.bazel
@@ -5,5 +5,4 @@ go_library(
     srcs = ["metrics.go"],
     importpath = "github.com/scionproto/scion/go/beacon_srv/internal/metrics",
     visibility = ["//go/beacon_srv:__subpackages__"],
-    deps = ["//go/lib/prom:go_default_library"],
 )
diff --git a/go/beacon_srv/internal/metrics/metrics.go b/go/beacon_srv/internal/metrics/metrics.go
@@ -14,15 +14,5 @@
 
 package metrics
 
-import (
-	"github.com/scionproto/scion/go/lib/prom"
-)
-
-const (
-	namespace = "beacon_srv"
-)
-
-// Init initializes the metrics for the beacon server.
-func Init(elem string) {
-	prom.UseDefaultRegWithElem(elem)
-}
+// Namespace is the metrics namespace for the beacon server.
+const namespace = "bs"
diff --git a/go/beacon_srv/main.go b/go/beacon_srv/main.go
@@ -36,7 +36,6 @@ import (
 	"github.com/scionproto/scion/go/beacon_srv/internal/config"
 	"github.com/scionproto/scion/go/beacon_srv/internal/ifstate"
 	"github.com/scionproto/scion/go/beacon_srv/internal/keepalive"
-	"github.com/scionproto/scion/go/beacon_srv/internal/metrics"
 	"github.com/scionproto/scion/go/beacon_srv/internal/onehop"
 	"github.com/scionproto/scion/go/beacon_srv/internal/revocation"
 	"github.com/scionproto/scion/go/lib/addr"
@@ -54,6 +53,7 @@ import (
 	"github.com/scionproto/scion/go/lib/keyconf"
 	"github.com/scionproto/scion/go/lib/log"
 	"github.com/scionproto/scion/go/lib/periodic"
+	"github.com/scionproto/scion/go/lib/prom"
 	"github.com/scionproto/scion/go/lib/scrypto"
 	"github.com/scionproto/scion/go/lib/snet"
 	"github.com/scionproto/scion/go/lib/sock/reliable"
@@ -544,7 +544,7 @@ func setupBasic() error {
 	if err := env.InitLogging(&cfg.Logging); err != nil {
 		return err
 	}
-	metrics.Init(cfg.General.ID)
+	prom.ExportElementID(cfg.General.ID)
 	return env.LogAppStarted(common.BS, cfg.General.ID)
 }
 

diff --git a/go/border/BUILD.bazel b/go/border/BUILD.bazel
@@ -62,7 +62,6 @@ go_test(
     embed = [":go_default_library"],
     deps = [
         "//go/border/brconf:go_default_library",
-        "//go/border/metrics:go_default_library",
         "//go/border/rctx:go_default_library",
         "//go/border/rpkt:go_default_library",
         "//go/lib/addr:go_default_library",

diff --git a/go/border/main.go b/go/border/main.go
@@ -35,6 +35,7 @@ import (
 	"github.com/scionproto/scion/go/lib/fatal"
 	"github.com/scionproto/scion/go/lib/log"
 	"github.com/scionproto/scion/go/lib/profile"
+	"github.com/scionproto/scion/go/lib/prom"
 )
 
 var (
@@ -104,6 +105,7 @@ func setupBasic() error {
 	if err := env.InitLogging(&cfg.Logging); err != nil {
 		return err
 	}
+	prom.ExportElementID(cfg.General.ID)
 	return env.LogAppStarted(common.BR, cfg.General.ID)
 }
 

diff --git a/go/border/metrics/metrics.go b/go/border/metrics/metrics.go
@@ -24,6 +24,9 @@ import (
 	"github.com/scionproto/scion/go/lib/ringbuf"
 )
 
+// Namespace is the metrics namespace for the border router.
+const Namespace = "br"
+
 // Declare prometheus metrics to export.
 var (
 	// High-level input stats
@@ -55,26 +58,23 @@ var (
 	IFState *prometheus.GaugeVec
 )
 
-// Init ensures all metrics are registered.
-func Init(elem string) {
-	namespace := "border"
+func init() {
 	sockLabels := []string{"sock"}
 
-	prom.UseDefaultRegWithElem(elem)
 	// Some closures to reduce boiler-plate.
 	newCVec := func(name, help string, lNames []string) *prometheus.CounterVec {
-		return prom.NewCounterVec(namespace, "", name, help, lNames)
+		return prom.NewCounterVec(Namespace, "", name, help, lNames)
 	}
 	newG := func(name, help string) prometheus.Gauge {
-		return prom.NewGauge(namespace, "", name, help)
+		return prom.NewGauge(Namespace, "", name, help)
 	}
 	newGVec := func(name, help string, lNames []string) *prometheus.GaugeVec {
-		return prom.NewGaugeVec(namespace, "", name, help, lNames)
+		return prom.NewGaugeVec(Namespace, "", name, help, lNames)
 	}
 	newHVec := func(name, help string,
 		lNames []string, buckets []float64) *prometheus.HistogramVec {
 
-		return prom.NewHistogramVec(namespace, "", name, help, lNames, buckets)
+		return prom.NewHistogramVec(Namespace, "", name, help, lNames, buckets)
 	}
 
 	InputPkts = newCVec("input_pkts_total", "Total number of input packets received.", sockLabels)
@@ -116,5 +116,5 @@ func Init(elem string) {
 	IFState = newGVec("interface_active", "Interface is active.", sockLabels)
 
 	// Initialize ringbuf metrics.
-	ringbuf.InitMetrics("border", []string{"ringId"})
+	ringbuf.InitMetrics(Namespace, []string{"ringId"})
 }
diff --git a/go/border/router.go b/go/border/router.go
@@ -21,7 +21,6 @@ import (
 	"sync"
 
 	"github.com/scionproto/scion/go/border/brconf"
-	"github.com/scionproto/scion/go/border/metrics"
 	"github.com/scionproto/scion/go/border/rcmn"
 	"github.com/scionproto/scion/go/border/rctrl"
 	"github.com/scionproto/scion/go/border/rctx"
@@ -55,7 +54,6 @@ type Router struct {
 }
 
 func NewRouter(id, confDir string) (*Router, error) {
-	metrics.Init(id)
 	r := &Router{Id: id, confDir: confDir}
 	if err := r.setup(); err != nil {
 		return nil, err

diff --git a/go/border/setup_test.go b/go/border/setup_test.go
@@ -23,7 +23,6 @@ import (
 	. "github.com/smartystreets/goconvey/convey"
 
 	"github.com/scionproto/scion/go/border/brconf"
-	"github.com/scionproto/scion/go/border/metrics"
 	"github.com/scionproto/scion/go/border/rctx"
 	"github.com/scionproto/scion/go/border/rpkt"
 	"github.com/scionproto/scion/go/lib/common"
@@ -304,7 +303,6 @@ func setupTestRouter(t *testing.T) (*Router, *rctx.Ctx) {
 func initTestRouter(maxNumPosixInput int) *Router {
 	// Init metrics.
 	testInitOnce.Do(func() {
-		metrics.Init("br1-ff00_0_111-1")
 		// Reduce output displayed in goconvey.
 		log.Root().SetHandler(log.DiscardHandler())
 	})

diff --git a/go/cert_srv/BUILD.bazel b/go/cert_srv/BUILD.bazel
@@ -11,7 +11,6 @@ go_library(
     visibility = ["//visibility:private"],
     deps = [
         "//go/cert_srv/internal/config:go_default_library",
-        "//go/cert_srv/internal/metrics:go_default_library",
         "//go/cert_srv/internal/reiss:go_default_library",
         "//go/lib/addr:go_default_library",
         "//go/lib/common:go_default_library",
@@ -27,6 +26,7 @@ go_library(
         "//go/lib/infra/modules/trust/trustdb:go_default_library",
         "//go/lib/log:go_default_library",
         "//go/lib/periodic:go_default_library",
+        "//go/lib/prom:go_default_library",
         "//go/lib/snet:go_default_library",
         "//go/lib/topology:go_default_library",
         "//go/proto:go_default_library",

diff --git a/go/cert_srv/internal/metrics/BUILD.bazel b/go/cert_srv/internal/metrics/BUILD.bazel
@@ -5,5 +5,4 @@ go_library(
     srcs = ["metrics.go"],
     importpath = "github.com/scionproto/scion/go/cert_srv/internal/metrics",
     visibility = ["//go/cert_srv:__subpackages__"],
-    deps = ["//go/lib/prom:go_default_library"],
 )
diff --git a/go/cert_srv/internal/metrics/metrics.go b/go/cert_srv/internal/metrics/metrics.go
@@ -14,15 +14,5 @@
 
 package metrics
 
-import (
-	"github.com/scionproto/scion/go/lib/prom"
-)
-
-const (
-	namespace = "cert_srv"
-)
-
-// Init initializes the metrics for the CS.
-func Init(elem string) {
-	prom.UseDefaultRegWithElem(elem)
-}
+// Namespace is the metrics namespace for the certificate server.
+const Namespace = "cs"
diff --git a/go/cert_srv/setup.go b/go/cert_srv/setup.go
@@ -22,7 +22,6 @@ import (
 	"github.com/BurntSushi/toml"
 
 	"github.com/scionproto/scion/go/cert_srv/internal/config"
-	"github.com/scionproto/scion/go/cert_srv/internal/metrics"
 	"github.com/scionproto/scion/go/cert_srv/internal/reiss"
 	"github.com/scionproto/scion/go/lib/addr"
 	"github.com/scionproto/scion/go/lib/common"
@@ -34,6 +33,7 @@ import (
 	"github.com/scionproto/scion/go/lib/infra/modules/trust"
 	"github.com/scionproto/scion/go/lib/infra/modules/trust/trustdb"
 	"github.com/scionproto/scion/go/lib/log"
+	"github.com/scionproto/scion/go/lib/prom"
 	"github.com/scionproto/scion/go/lib/snet"
 	"github.com/scionproto/scion/go/lib/topology"
 	"github.com/scionproto/scion/go/proto"
@@ -57,7 +57,7 @@ func setupBasic() error {
 	if err := env.InitLogging(&cfg.Logging); err != nil {
 		return err
 	}
-	metrics.Init(cfg.General.ID)
+	prom.ExportElementID(cfg.General.ID)
 	return env.LogAppStarted(common.CS, cfg.General.ID)
 }
 

diff --git a/go/godispatcher/BUILD.bazel b/go/godispatcher/BUILD.bazel
@@ -8,7 +8,6 @@ go_library(
     visibility = ["//visibility:private"],
     deps = [
         "//go/godispatcher/internal/config:go_default_library",
-        "//go/godispatcher/internal/metrics:go_default_library",
         "//go/godispatcher/network:go_default_library",
         "//go/lib/common:go_default_library",
         "//go/lib/env:go_default_library",
@@ -30,7 +29,6 @@ go_test(
     srcs = ["main_test.go"],
     embed = [":go_default_library"],
     deps = [
-        "//go/godispatcher/internal/metrics:go_default_library",
         "//go/lib/addr:go_default_library",
         "//go/lib/common:go_default_library",
         "//go/lib/hpkt:go_default_library",

diff --git a/go/godispatcher/internal/metrics/metrics.go b/go/godispatcher/internal/metrics/metrics.go
@@ -15,18 +15,15 @@
 package metrics
 
 import (
-	"sync"
-
 	"github.com/prometheus/client_golang/prometheus"
 
 	"github.com/scionproto/scion/go/lib/addr"
 	"github.com/scionproto/scion/go/lib/prom"
 	"github.com/scionproto/scion/go/lib/ringbuf"
 )
 
-const (
-	namespace = "dispatcher"
-)
+// Namespace is the metrics namespace for the dispatcher.
+const Namespace = "disp"
 
 // Label descriptions
 const (
@@ -58,26 +55,16 @@ func GetOpenConnectionLabel(svc addr.HostSVC) string {
 	return svc.BaseString()
 }
 
-var initSentinel sync.Once
-
-// Init initializes the metrics for the dispatcher.
-func Init(elem string) {
-	initSentinel.Do(func() {
-		initMetrics(elem)
-	})
-}
-
-func initMetrics(elem string) {
-	prom.UseDefaultRegWithElem(elem)
-	ringbuf.InitMetrics("dispatcher", nil)
-	OutgoingBytesTotal = prom.NewCounter(namespace, "", "outgoing_bytes_total",
+func init() {
+	ringbuf.InitMetrics(Namespace, nil)
+	OutgoingBytesTotal = prom.NewCounter(Namespace, "", "outgoing_bytes_total",
 		"Total bytes sent on the network.")
-	OutgoingPacketsTotal = prom.NewCounter(namespace, "", "outgoing_packets_total",
+	OutgoingPacketsTotal = prom.NewCounter(Namespace, "", "outgoing_packets_total",
 		"Total packets sent on the network.")
-	IncomingBytesTotal = prom.NewCounter(namespace, "", "incoming_bytes_total",
+	IncomingBytesTotal = prom.NewCounter(Namespace, "", "incoming_bytes_total",
 		"Total bytes received from the network irrespective of packet outcome.")
-	IncomingPackets = prom.NewCounterVec(namespace, "", "incoming_packets_total",
+	IncomingPackets = prom.NewCounterVec(Namespace, "", "incoming_packets_total",
 		"Total packets received from the network.", []string{IncomingPacketOutcome})
-	OpenSockets = prom.NewGaugeVec(namespace, "", "open_application_connections",
+	OpenSockets = prom.NewGaugeVec(Namespace, "", "open_application_connections",
 		"Number of sockets currently opened by applications.", []string{OpenConnectionType})
 }
diff --git a/go/godispatcher/main.go b/go/godispatcher/main.go
@@ -26,7 +26,6 @@ import (
 	"github.com/BurntSushi/toml"
 
 	"github.com/scionproto/scion/go/godispatcher/internal/config"
-	"github.com/scionproto/scion/go/godispatcher/internal/metrics"
 	"github.com/scionproto/scion/go/godispatcher/network"
 	"github.com/scionproto/scion/go/lib/common"
 	"github.com/scionproto/scion/go/lib/env"
@@ -124,7 +123,6 @@ func setupBasic() error {
 	if err := env.InitLogging(&cfg.Logging); err != nil {
 		return err
 	}
-	metrics.Init(cfg.Dispatcher.ID)
 	return env.LogAppStarted("Dispatcher", cfg.Dispatcher.ID)
 }
 

diff --git a/go/godispatcher/main_test.go b/go/godispatcher/main_test.go
@@ -24,7 +24,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/scionproto/scion/go/godispatcher/internal/metrics"
 	"github.com/scionproto/scion/go/lib/addr"
 	"github.com/scionproto/scion/go/lib/common"
 	"github.com/scionproto/scion/go/lib/hpkt"
@@ -519,9 +518,6 @@ func MustPackQuotedSCMPL4Header(header *scmp.Hdr, meta *scmp.Meta, info scmp.Inf
 }
 
 func TestMain(m *testing.M) {
-	// If the prometheus package is not initialized, dispatcher internals panic
-	// because the counters are nil.
-	metrics.Init("dispatcher")
 	log.Root().SetHandler(log.DiscardHandler())
 	os.Exit(m.Run())
 }
diff --git a/go/lib/infra/messenger/metrics.go b/go/lib/infra/messenger/metrics.go
@@ -127,7 +127,7 @@ func errorToResultLabel(ctx context.Context, err error) string {
 	// TODO(lukedirtwalker): categorize error better.
 	switch {
 	case err == nil:
-		return prom.ResultOk
+		return prom.Success
 	case common.IsTimeoutErr(err):
 		return prom.ErrTimeout
 	default:

diff --git a/go/lib/infra/metrics.go b/go/lib/infra/metrics.go
@@ -52,7 +52,7 @@ var (
 	metricsErrRevCache   = &HandlerResult{Result: "err_revcache", Status: prom.StatusErr}
 	metricsErrRevCacheTo = &HandlerResult{Result: "err_revcache_to", Status: prom.StatusTimeout}
 
-	MetricsResultOk = &HandlerResult{Result: prom.ResultOk, Status: prom.StatusOk}
+	MetricsResultOk = &HandlerResult{Result: prom.Success, Status: prom.StatusOk}
 )
 
 func MetricsErrTrustDB(err error) *HandlerResult {

diff --git a/go/lib/infra/modules/db/metrics.go b/go/lib/infra/modules/db/metrics.go
@@ -23,7 +23,7 @@ import (
 func ErrToMetricLabel(err error) string {
 	switch {
 	case err == nil:
-		return prom.ResultOk
+		return prom.Success
 	case common.IsTimeoutErr(err):
 		return prom.ErrTimeout
 	default: