plugin/metrics: add MustRegister function (#1648)

This registers the Collectors iff the metrics plugin has been loaded.
Safes a bunch of code in each and every plugin's setup code.

plugin/autopath/setup.go

@@ -26,15 +26,7 @@ func setup(c *caddy.Controller) error {
 	}
 
 	c.OnStartup(func() error {
-		once.Do(func() {
+		once.Do(func() { metrics.MustRegister(c, AutoPathCount) })
-			m := dnsserver.GetConfig(c).Handler("prometheus")
-			if m == nil {
-				return
-			}
-			if x, ok := m.(*metrics.Metrics); ok {
-				x.MustRegister(AutoPathCount)
-			}
-		})
 		return nil
 	})
 

plugin/cache/setup.go

@@ -32,18 +32,10 @@ func setup(c *caddy.Controller) error {
 
 	c.OnStartup(func() error {
 		once.Do(func() {
-			m := dnsserver.GetConfig(c).Handler("prometheus")
+			metrics.MustRegister(c,
-			if m == nil {
+				cacheSize, cacheCapacity,
-				return
+				cacheHits, cacheMisses,
-			}
+				cachePrefetches, cacheDrops)
-			if x, ok := m.(*metrics.Metrics); ok {
-				x.MustRegister(cacheSize)
-				x.MustRegister(cacheCapacity)
-				x.MustRegister(cacheHits)
-				x.MustRegister(cacheMisses)
-				x.MustRegister(cachePrefetches)
-				x.MustRegister(cacheDrops)
-			}
 		})
 		return nil
 	})

plugin/dnssec/setup.go

@@ -33,16 +33,7 @@ func setup(c *caddy.Controller) error {
 
 	c.OnStartup(func() error {
 		once.Do(func() {
-			m := dnsserver.GetConfig(c).Handler("prometheus")
+			metrics.MustRegister(c, cacheSize, cacheCapacity, cacheHits, cacheMisses)
-			if m == nil {
-				return
-			}
-			if x, ok := m.(*metrics.Metrics); ok {
-				x.MustRegister(cacheSize)
-				x.MustRegister(cacheCapacity)
-				x.MustRegister(cacheHits)
-				x.MustRegister(cacheMisses)
-			}
 		})
 		return nil
 	})

plugin/forward/setup.go

@@ -38,17 +38,7 @@ func setup(c *caddy.Controller) error {
 
 	c.OnStartup(func() error {
 		once.Do(func() {
-			m := dnsserver.GetConfig(c).Handler("prometheus")
+			metrics.MustRegister(c, RequestCount, RcodeCount, RequestDuration, HealthcheckFailureCount, SocketGauge)
-			if m == nil {
-				return
-			}
-			if x, ok := m.(*metrics.Metrics); ok {
-				x.MustRegister(RequestCount)
-				x.MustRegister(RcodeCount)
-				x.MustRegister(RequestDuration)
-				x.MustRegister(HealthcheckFailureCount)
-				x.MustRegister(SocketGauge)
-			}
 		})
 		return f.OnStartup()
 	})

plugin/health/overloaded.go

@@ -49,4 +49,4 @@ var (
 	})
 )
 
-var onceMetric sync.Once
+var once sync.Once

plugin/health/setup.go

@@ -55,15 +55,7 @@ func setup(c *caddy.Controller) error {
 	})
 
 	c.OnStartup(func() error {
-		onceMetric.Do(func() {
+		once.Do(func() { metrics.MustRegister(c, HealthDuration) })
-			m := dnsserver.GetConfig(c).Handler("prometheus")
-			if m == nil {
-				return
-			}
-			if x, ok := m.(*metrics.Metrics); ok {
-				x.MustRegister(HealthDuration)
-			}
-		})
 		return nil
 	})
 

plugin/metrics/register.go

@@ -0,0 +1,23 @@
+package metrics
+
+import (
+	"github.com/coredns/coredns/core/dnsserver"
+
+	"github.com/mholt/caddy"
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+// MustRegister registers the prometheus Collectors when the metrics middleware is used.
+func MustRegister(c *caddy.Controller, cs ...prometheus.Collector) {
+	m := dnsserver.GetConfig(c).Handler("prometheus")
+	if m == nil {
+		return
+	}
+	x, ok := m.(*Metrics)
+	if !ok {
+		return
+	}
+	for _, c := range cs {
+		x.MustRegister(c)
+	}
+}

plugin/proxy/setup.go

@@ -30,16 +30,7 @@ func setup(c *caddy.Controller) error {
 	})
 
 	c.OnStartup(func() error {
-		once.Do(func() {
+		once.Do(func() { metrics.MustRegister(c, RequestCount, RequestDuration) })
-			m := dnsserver.GetConfig(c).Handler("prometheus")
-			if m == nil {
-				return
-			}
-			if x, ok := m.(*metrics.Metrics); ok {
-				x.MustRegister(RequestCount)
-				x.MustRegister(RequestDuration)
-			}
-		})
 		return nil
 	})
 

plugin/template/metrics.go

@@ -3,7 +3,6 @@ package template
 import (
 	"sync"
 
-	"github.com/coredns/coredns/core/dnsserver"
 	"github.com/coredns/coredns/plugin"
 	"github.com/coredns/coredns/plugin/metrics"
 
@@ -37,15 +36,7 @@ var (
 func setupMetrics(c *caddy.Controller) error {
 	c.OnStartup(func() error {
 		metricsOnce.Do(func() {
-			m := dnsserver.GetConfig(c).Handler("prometheus")
+			metrics.MustRegister(c, TemplateMatchesCount, TemplateFailureCount, TemplateRRFailureCount)
-			if m == nil {
-				return
-			}
-			if x, ok := m.(*metrics.Metrics); ok {
-				x.MustRegister(TemplateMatchesCount)
-				x.MustRegister(TemplateFailureCount)
-				x.MustRegister(TemplateRRFailureCount)
-			}
 		})
 		return nil
 	})