refactor: rename RouteAdded and RouteDeleted metrics

Author: Soha-Albaghdady

src/code.cloudfoundry.org/gorouter/metrics/compositereporter.go

@@ -39,8 +39,8 @@ type MetricReporter interface {
 	CaptureRoutesPruned(prunedRoutes uint64)
 	CaptureLookupTime(t time.Duration)
 	CaptureRegistryMessage(msg ComponentTagged, action string)
-	CaptureRouteAdded()
-	CaptureRouteDeleted()
+	CaptureRoutesRegistered()
+	CaptureRoutesUnregistered()
 	CaptureRouteRegistrationLatency(t time.Duration)
 	CaptureUnregistryMessage(msg ComponentTagged)
 	CaptureFoundFileDescriptors(files int)
@@ -200,15 +200,15 @@ func (m MultiMetricReporter) CaptureUnregistryMessage(msg ComponentTagged) {
 	}
 }
 
-func (m MultiMetricReporter) CaptureRouteAdded() {
+func (m MultiMetricReporter) CaptureRoutesRegistered() {
 	for _, r := range m {
-		r.CaptureRouteAdded()
+		r.CaptureRoutesRegistered()
 	}
 }
 
-func (m MultiMetricReporter) CaptureRouteDeleted() {
+func (m MultiMetricReporter) CaptureRoutesUnregistered() {
 	for _, r := range m {
-		r.CaptureRouteAdded()
+		r.CaptureRoutesUnregistered()
 	}
 }
 

src/code.cloudfoundry.org/gorouter/metrics/fakes/fake_metricreporter.go

@@ -168,12 +168,12 @@ func (m *Metrics) CaptureUnregistryMessage(msg ComponentTagged) {
 	}
 }
 
-func (m *Metrics) CaptureRouteAdded() {
-	m.Batcher.BatchIncrementCounter("routes_added")
+func (m *Metrics) CaptureRoutesRegistered() {
+	m.Batcher.BatchIncrementCounter("routes_registered")
 }
 
-func (m *Metrics) CaptureRouteDeleted() {
-	m.Batcher.BatchIncrementCounter("routes_deleted")
+func (m *Metrics) CaptureRoutesUnregistered() {
+	m.Batcher.BatchIncrementCounter("routes_unregistered")
 }
 
 func (m *Metrics) CaptureWebSocketUpdate() {

src/code.cloudfoundry.org/gorouter/metrics/metricsreporter.go

@@ -524,16 +524,16 @@ var _ = Describe("MetricsReporter", func() {
 		Expect(count).To(Equal(uint64(5)))
 	})
 
-	It("increments the routes_added metric", func() {
-		metricReporter.CaptureRouteAdded()
+	It("increments the routes_registered metric", func() {
+		metricReporter.CaptureRoutesRegistered()
 		Expect(batcher.BatchIncrementCounterCallCount()).To(Equal(1))
-		Expect(batcher.BatchIncrementCounterArgsForCall(0)).To(Equal("routes_added"))
+		Expect(batcher.BatchIncrementCounterArgsForCall(0)).To(Equal("routes_registered"))
 	})
 
-	It("increments the routes_deleted metric", func() {
-		metricReporter.CaptureRouteDeleted()
+	It("increments the routes_unregistered metric", func() {
+		metricReporter.CaptureRoutesUnregistered()
 		Expect(batcher.BatchIncrementCounterCallCount()).To(Equal(1))
-		Expect(batcher.BatchIncrementCounterArgsForCall(0)).To(Equal("routes_deleted"))
+		Expect(batcher.BatchIncrementCounterArgsForCall(0)).To(Equal("routes_unregistered"))
 	})
 
 	It("increments the backend_tls_handshake_failed metric", func() {

src/code.cloudfoundry.org/gorouter/metrics/metricsreporter_test.go

@@ -18,8 +18,8 @@ type Metrics struct {
 	RouteRegistration           mr.CounterVec
 	RouteUnregistration         mr.CounterVec
 	RoutesPruned                mr.Counter
-	RoutesAdded                 mr.Counter
-	RoutesDeleted               mr.Counter
+	RoutesRegistered            mr.Counter
+	RoutesUnregistered          mr.Counter
 	TotalRoutes                 mr.Gauge
 	TimeSinceLastRegistryUpdate mr.Gauge
 	RouteLookupTime             mr.Histogram
@@ -66,8 +66,8 @@ func NewMetrics(registry *mr.Registry, perRequestMetricsReporting bool, meterCon
 		RouteRegistration:           registry.NewCounterVec("registry_message", "number of route registration messages", []string{"component", "action"}),
 		RouteUnregistration:         registry.NewCounterVec("unregistry_message", "number of unregister messages", []string{"component"}),
 		RoutesPruned:                registry.NewCounter("routes_pruned", "number of pruned routes"),
-		RoutesAdded:                 registry.NewCounter("routes_added", "number of added routes"),
-		RoutesDeleted:               registry.NewCounter("routes_deleted", "number of deleted routes"),
+		RoutesRegistered:            registry.NewCounter("routes_registered", "number of registered routes"),
+		RoutesUnregistered:          registry.NewCounter("routes_unregistered", "number of unregistered routes"),
 		TotalRoutes:                 registry.NewGauge("total_routes", "number of total routes"),
 		TimeSinceLastRegistryUpdate: registry.NewGauge("ms_since_last_registry_update", "time since last registry update in ms"),
 		RouteLookupTime:             registry.NewHistogram("route_lookup_time", "route lookup time per request in ns", meterConfig.RouteLookupTimeHistogramBuckets),
@@ -111,12 +111,12 @@ func (metrics *Metrics) CaptureRoutesPruned(routesPruned uint64) {
 	metrics.RoutesPruned.Add(float64(routesPruned))
 }
 
-func (metrics *Metrics) CaptureRouteAdded() {
-	metrics.RoutesAdded.Add(1)
+func (metrics *Metrics) CaptureRoutesRegistered() {
+	metrics.RoutesRegistered.Add(1)
 }
 
-func (metrics *Metrics) CaptureRouteDeleted() {
-	metrics.RoutesDeleted.Add(1)
+func (metrics *Metrics) CaptureRoutesUnregistered() {
+	metrics.RoutesUnregistered.Add(1)
 }
 func (metrics *Metrics) CaptureTotalRoutes(totalRoutes int) {
 	metrics.TotalRoutes.Set(float64(totalRoutes))

src/code.cloudfoundry.org/gorouter/metrics_prometheus/metrics.go

@@ -99,13 +99,13 @@ var _ = Describe("Metrics", func() {
 			Expect(getMetrics(r.Port())).To(ContainSubstring(`routes_pruned 50`))
 		})
 
-		It("increments the routes added metric", func() {
-			m.CaptureRouteAdded()
-			Expect(getMetrics(r.Port())).To(ContainSubstring(`routes_added 1`))
+		It("increments the routes registered metric", func() {
+			m.CaptureRoutesRegistered()
+			Expect(getMetrics(r.Port())).To(ContainSubstring(`routes_registered 1`))
 		})
-		It("increments the routes deleted metric", func() {
-			m.CaptureRouteDeleted()
-			Expect(getMetrics(r.Port())).To(ContainSubstring(`routes_deleted 1`))
+		It("increments the routes unregistered metric", func() {
+			m.CaptureRoutesUnregistered()
+			Expect(getMetrics(r.Port())).To(ContainSubstring(`routes_unregistered 1`))
 		})
 
 		Describe("captures route registration latency", func() {

src/code.cloudfoundry.org/gorouter/metrics_prometheus/metrics_test.go

@@ -88,19 +88,19 @@ func (r *RouteRegistry) Register(uri route.Uri, endpoint *route.Endpoint) {
 		return
 	}
 
-	poolPutResult, routeAdded := r.register(uri, endpoint)
+	poolPutResult, routePoolAdded := r.register(uri, endpoint)
 
 	r.reporter.CaptureRegistryMessage(endpoint, poolPutResult.String())
 
 	if poolPutResult == route.EndpointAdded && !endpoint.UpdatedAt.IsZero() {
 		r.reporter.CaptureRouteRegistrationLatency(time.Since(endpoint.UpdatedAt))
 	}
 
-	if routeAdded {
+	if routePoolAdded {
 		r.logger.Info("route-registered", slog.Any("uri", uri))
 		// for backward compatibility:
 		r.logger.Debug("uri-added", slog.Any("uri", uri))
-		r.reporter.CaptureRouteAdded()
+		r.reporter.CaptureRoutesRegistered()
 	}
 
 	switch poolPutResult {
@@ -123,7 +123,7 @@ func (r *RouteRegistry) Register(uri route.Uri, endpoint *route.Endpoint) {
 	}
 }
 
-func (r *RouteRegistry) register(uri route.Uri, endpoint *route.Endpoint) (putResult route.PoolPutResult, routeAdded bool) {
+func (r *RouteRegistry) register(uri route.Uri, endpoint *route.Endpoint) (putResult route.PoolPutResult, routePoolAdded bool) {
 	r.RLock()
 	defer r.RUnlock()
 
@@ -134,7 +134,7 @@ func (r *RouteRegistry) register(uri route.Uri, endpoint *route.Endpoint) (putRe
 	if pool == nil {
 		// release read lock, insertRouteKey() will acquire a write lock.
 		r.RUnlock()
-		pool, routeAdded = r.insertRouteKey(routekey, uri)
+		pool, routePoolAdded = r.insertRouteKey(routekey, uri)
 		r.RLock()
 	}
 
@@ -146,7 +146,7 @@ func (r *RouteRegistry) register(uri route.Uri, endpoint *route.Endpoint) (putRe
 	// Overwrites the load balancing algorithm of a pool by that of a specified endpoint, if that is valid.
 	r.SetTimeOfLastUpdate(t)
 
-	return putResult, routeAdded
+	return putResult, routePoolAdded
 }
 
 // insertRouteKey acquires a write lock, inserts the route key into the registry and releases the
@@ -186,7 +186,7 @@ func (r *RouteRegistry) Unregister(uri route.Uri, endpoint *route.Endpoint) {
 
 	if routeRemoved {
 		r.logger.Info("route-unregistered", slog.Any("uri", uri))
-		r.reporter.CaptureRouteDeleted()
+		r.reporter.CaptureRoutesUnregistered()
 	} else {
 		r.logger.Info("route-not-unregistered", slog.Any("uri", uri))
 	}