refactor: get rid of multiple interfaces

Author: mike-jc

handlers/httplatencyprometheus.go

@@ -10,11 +10,11 @@ import (
 )
 
 type httpLatencyPrometheusHandler struct {
-	reporter metrics.ProxyReporter
+	reporter metrics.MetricReporter
 }
 
 // NewHTTPLatencyPrometheus creates a new handler that handles prometheus metrics for latency
-func NewHTTPLatencyPrometheus(reporter metrics.ProxyReporter) negroni.Handler {
+func NewHTTPLatencyPrometheus(reporter metrics.MetricReporter) negroni.Handler {
 	return &httpLatencyPrometheusHandler{
 		reporter: reporter,
 	}

handlers/httplatencyprometheus_test.go

@@ -24,7 +24,7 @@ var _ = Describe("Http Prometheus Latency", func() {
 		resp http.ResponseWriter
 		req  *http.Request
 
-		fakeReporter *metrics_fakes.FakeProxyReporter
+		fakeReporter *metrics_fakes.FakeMetricReporter
 
 		nextCalled bool
 	)
@@ -34,7 +34,7 @@ var _ = Describe("Http Prometheus Latency", func() {
 		req = test_util.NewRequest("GET", "example.com", "/", body)
 		resp = httptest.NewRecorder()
 
-		fakeReporter = new(metrics_fakes.FakeProxyReporter)
+		fakeReporter = new(metrics_fakes.FakeMetricReporter)
 
 		nextHandler = http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
 			_, err := io.ReadAll(req.Body)

handlers/lookup.go

@@ -36,7 +36,7 @@ func (err InvalidProcessInstanceHeaderError) Error() string {
 
 type lookupHandler struct {
 	registry                 registry.Registry
-	reporter                 metrics.ProxyReporter
+	reporter                 metrics.MetricReporter
 	logger                   *slog.Logger
 	errorWriter              errorwriter.ErrorWriter
 	EmptyPoolResponseCode503 bool
@@ -45,7 +45,7 @@ type lookupHandler struct {
 // NewLookup creates a handler responsible for looking up a route.
 func NewLookup(
 	registry registry.Registry,
-	rep metrics.ProxyReporter,
+	rep metrics.MetricReporter,
 	logger *slog.Logger,
 	ew errorwriter.ErrorWriter,
 	emptyPoolResponseCode503 bool,

handlers/lookup_test.go

@@ -29,7 +29,7 @@ var _ = Describe("Lookup", func() {
 		testSink       *test_util.TestSink
 		logger         *slog.Logger
 		reg            *fakeRegistry.FakeRegistry
-		rep            *fakes.FakeProxyReporter
+		rep            *fakes.FakeMetricReporter
 		resp           *httptest.ResponseRecorder
 		req            *http.Request
 		nextCalled     bool
@@ -54,7 +54,7 @@ var _ = Describe("Lookup", func() {
 		testSink = &test_util.TestSink{Buffer: gbytes.NewBuffer()}
 		log.SetDynamicWriteSyncer(zapcore.NewMultiWriteSyncer(testSink, zapcore.AddSync(GinkgoWriter)))
 		log.SetLoggingLevel("Debug")
-		rep = &fakes.FakeProxyReporter{}
+		rep = &fakes.FakeMetricReporter{}
 		reg = &fakeRegistry.FakeRegistry{}
 		handler = negroni.New()
 		req = test_util.NewRequest("GET", "example.com", "/", nil)

handlers/reporter.go

@@ -14,13 +14,13 @@ import (
 )
 
 type reporterHandler struct {
-	reporter metrics.ProxyReporter
+	reporter metrics.MetricReporter
 	logger   *slog.Logger
 }
 
 // NewReporter creates a new handler that handles reporting backend
 // responses to metrics and missing Content-Length header
-func NewReporter(reporter metrics.ProxyReporter, logger *slog.Logger) negroni.Handler {
+func NewReporter(reporter metrics.MetricReporter, logger *slog.Logger) negroni.Handler {
 	return &reporterHandler{
 		reporter: reporter,
 		logger:   logger,

handlers/reporter_test.go

@@ -26,7 +26,7 @@ var _ = Describe("Reporter Handler", func() {
 		resp http.ResponseWriter
 		req  *http.Request
 
-		fakeReporter *metrics_fakes.FakeProxyReporter
+		fakeReporter *metrics_fakes.FakeMetricReporter
 		logger       *test_util.TestLogger
 		prevHandler  negroni.Handler
 
@@ -38,7 +38,7 @@ var _ = Describe("Reporter Handler", func() {
 		req = test_util.NewRequest("GET", "example.com", "/", body)
 		resp = httptest.NewRecorder()
 
-		fakeReporter = new(metrics_fakes.FakeProxyReporter)
+		fakeReporter = new(metrics_fakes.FakeMetricReporter)
 		logger = test_util.NewTestLogger("test")
 
 		nextHandler = http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {

main.go

@@ -128,42 +128,24 @@ func main() {
 	dropReporter := initializeDropsondeReporter(prefix, logger, c)
 	promReporter := initializePrometheusReporter(c)
 
-	routeRegistryReporters := make([]metrics.RouteRegistryReporter, 0)
+	reporters := make([]metrics.MetricReporter, 0)
 	if dropReporter != nil {
-		routeRegistryReporters = append(routeRegistryReporters, dropReporter)
+		reporters = append(reporters, dropReporter)
 	}
 	if promReporter != nil {
-		routeRegistryReporters = append(routeRegistryReporters, promReporter)
+		reporters = append(reporters, promReporter)
 	}
-	registryMetrics := metrics.NewMultiRouteRegistryReporter(routeRegistryReporters...)
+	metricReporter := metrics.NewMultiMetricReporter(reporters...)
 
-	proxyReporters := make([]metrics.ProxyReporter, 0)
-	if dropReporter != nil {
-		proxyReporters = append(proxyReporters, dropReporter)
-	}
-	if promReporter != nil {
-		proxyReporters = append(proxyReporters, promReporter)
-	}
-	proxyMetrics := metrics.NewMultiProxyReporter(proxyReporters...)
-
-	monitorReporters := make([]metrics.MonitorReporter, 0)
-	if dropReporter != nil {
-		monitorReporters = append(monitorReporters, dropReporter)
-	}
-	if promReporter != nil {
-		monitorReporters = append(monitorReporters, promReporter)
-	}
-	monitorMetrics := metrics.NewMultiMonitorReporter(monitorReporters...)
-
-	registry := rregistry.NewRouteRegistry(grlog.CreateLoggerWithSource(prefix, "registry"), c, registryMetrics)
+	registry := rregistry.NewRouteRegistry(grlog.CreateLoggerWithSource(prefix, "registry"), c, metricReporter)
 	varz := rvarz.NewVarz(registry)
-	compositeReporter := &metrics.CompositeReporter{VarzReporter: varz, ProxyReporter: proxyMetrics}
+	compositeReporter := &metrics.CompositeReporter{VarzReporter: varz, MetricReporter: metricReporter}
 
 	if c.SuspendPruningIfNatsUnavailable {
 		registry.SuspendPruning(func() bool { return !(natsClient.Status() == nats.CONNECTED) })
 	}
 
-	fdMonitor := initializeFDMonitor(monitorMetrics, grlog.CreateLoggerWithSource(prefix, "FileDescriptor"))
+	fdMonitor := initializeFDMonitor(metricReporter, grlog.CreateLoggerWithSource(prefix, "FileDescriptor"))
 
 	accessLogger, err := accesslog.CreateRunningAccessLogger(
 		grlog.CreateLoggerWithSource(prefix, "access-grlog"),
@@ -261,7 +243,7 @@ func main() {
 	}
 
 	subscriber := mbus.NewSubscriber(natsClient, registry, c, natsReconnected, grlog.CreateLoggerWithSource(prefix, "subscriber"))
-	natsMonitor := initializeNATSMonitor(subscriber, monitorMetrics, grlog.CreateLoggerWithSource(prefix, "NATSMonitor"))
+	natsMonitor := initializeNATSMonitor(subscriber, metricReporter, grlog.CreateLoggerWithSource(prefix, "NATSMonitor"))
 
 	members = append(members, grouper.Member{Name: "fdMonitor", Runner: fdMonitor})
 	members = append(members, grouper.Member{Name: "subscriber", Runner: subscriber})
@@ -273,8 +255,8 @@ func main() {
 	monitor := ifrit.Invoke(sigmon.New(group, syscall.SIGTERM, syscall.SIGINT, syscall.SIGUSR1))
 
 	go func() {
-		time.Sleep(c.RouteLatencyMetricMuzzleDuration)     // this way we avoid reporting metrics for pre-existing routes
-		registryMetrics.UnmuzzleRouteRegistrationLatency() // Required for Envelope V1. Keep it while we have both Envelope V1 and Prometheus.
+		time.Sleep(c.RouteLatencyMetricMuzzleDuration)    // this way we avoid reporting metrics for pre-existing routes
+		metricReporter.UnmuzzleRouteRegistrationLatency() // Required for Envelope V1. Keep it while we have both Envelope V1 and Prometheus.
 	}()
 
 	<-monitor.Ready()
@@ -289,7 +271,7 @@ func main() {
 }
 
 // initializeDropsondeReporter setups metrics via dropsonse if enabled
-func initializeDropsondeReporter(prefix string, logger *slog.Logger, c *config.Config) *metrics.MetricsReporter {
+func initializeDropsondeReporter(prefix string, logger *slog.Logger, c *config.Config) *metrics.Metrics {
 	if !c.EnableEnvelopeV1Metrics {
 		return nil
 	}
@@ -310,14 +292,14 @@ func initializePrometheusReporter(c *config.Config) *metrics_prometheus.Metrics
 	return metrics_prometheus.NewMetrics(promRegistry, c.PerRequestMetricsReporting, c.Prometheus.Meters)
 }
 
-func initializeFDMonitor(reporter metrics.MultiMonitorReporter, logger *slog.Logger) *monitor.FileDescriptor {
+func initializeFDMonitor(reporter metrics.MetricReporter, logger *slog.Logger) *monitor.FileDescriptor {
 	pid := os.Getpid()
 	path := fmt.Sprintf("/proc/%d/fd", pid)
 	ticker := time.NewTicker(time.Second * 5)
 	return monitor.NewFileDescriptor(path, ticker, reporter, logger)
 }
 
-func initializeNATSMonitor(subscriber *mbus.Subscriber, reporter metrics.MultiMonitorReporter, logger *slog.Logger) *monitor.NATSMonitor {
+func initializeNATSMonitor(subscriber *mbus.Subscriber, reporter metrics.MetricReporter, logger *slog.Logger) *monitor.NATSMonitor {
 	ticker := time.NewTicker(time.Second * 5)
 	return &monitor.NATSMonitor{
 		Subscriber: subscriber,
@@ -327,7 +309,7 @@ func initializeNATSMonitor(subscriber *mbus.Subscriber, reporter metrics.MultiMo
 	}
 }
 
-func initializeMetrics(sender *metric_sender.MetricSender, c *config.Config, logger *slog.Logger) *metrics.MetricsReporter {
+func initializeMetrics(sender *metric_sender.MetricSender, c *config.Config, logger *slog.Logger) *metrics.Metrics {
 	// 5 sec is dropsonde default batching interval
 	batcher := metricbatcher.New(sender, 5*time.Second)
 	batcher.AddConsistentlyEmittedMetrics("bad_gateways",
@@ -349,7 +331,7 @@ func initializeMetrics(sender *metric_sender.MetricSender, c *config.Config, log
 		"websocket_upgrades",
 	)
 
-	return &metrics.MetricsReporter{Sender: sender, Batcher: batcher, PerRequestMetricsReporting: c.PerRequestMetricsReporting, Logger: logger}
+	return &metrics.Metrics{Sender: sender, Batcher: batcher, PerRequestMetricsReporting: c.PerRequestMetricsReporting, Logger: logger}
 }
 
 func createCrypto(logger *slog.Logger, secret string) *secure.AesGCM {