rename SetPathFor404 to DoNotUseURLFor404

Author: therealak12

echoprometheus/prometheus.go

@@ -74,9 +74,9 @@ type MiddlewareConfig struct {
 
 	timeNow func() time.Time
 
-	// If SetPathFor404 is false, all 404 responses (due to non-matching route) will have the same `url` label and
+	// If DoNotUseURLFor404 is true, all 404 responses (due to non-matching route) will have the same `url` label and
 	// thus won't generate new metrics.
-	SetPathFor404 *bool
+	DoNotUseURLFor404 bool
 }
 
 type LabelValueFunc func(c echo.Context, err error) string
@@ -147,12 +147,6 @@ func NewMiddlewareWithConfig(config MiddlewareConfig) echo.MiddlewareFunc {
 
 // ToMiddleware converts configuration to middleware or returns an error.
 func (conf MiddlewareConfig) ToMiddleware() (echo.MiddlewareFunc, error) {
-	// for backwared compatiblity
-	if conf.SetPathFor404 == nil {
-		setPathFor404 := true
-		conf.SetPathFor404 = &setPathFor404
-	}
-
 	if conf.timeNow == nil {
 		conf.timeNow = time.Now
 	}
@@ -278,7 +272,7 @@ func (conf MiddlewareConfig) ToMiddleware() (echo.MiddlewareFunc, error) {
 			values[1] = c.Request().Method
 			values[2] = c.Request().Host
 			// as of Echo v4.10.1 an empty c.Path() means the router did not find any matching routes (404)
-			if c.Path() != "" || (conf.SetPathFor404 != nil && *conf.SetPathFor404) {
+			if c.Path() != "" || !conf.DoNotUseURLFor404 {
 				values[3] = url
 			}
 			for _, cv := range customValuers {

echoprometheus/prometheus_test.go

@@ -278,12 +278,12 @@ func TestRunPushGatewayGatherer(t *testing.T) {
 	unregisterDefaults("myapp")
 }
 
-// TestSetPathFor404Logic tests when the 404 response is due to no matching route, the url is not included in the metric
+// TestSetPathFor404NoMatchingRoute tests that the url is not included in the metric when
+// the 404 response is due to no matching route
 func TestSetPathFor404NoMatchingRoute(t *testing.T) {
 	e := echo.New()
 
-	setPathFor404 := false
-	e.Use(NewMiddlewareWithConfig(MiddlewareConfig{SetPathFor404: &setPathFor404, Subsystem: defaultSubsystem}))
+	e.Use(NewMiddlewareWithConfig(MiddlewareConfig{DoNotUseURLFor404: true, Subsystem: defaultSubsystem}))
 	e.GET("/metrics", NewHandler())
 
 	assert.Equal(t, http.StatusNotFound, request(e, "/nonExistentPath"))
@@ -296,13 +296,12 @@ func TestSetPathFor404NoMatchingRoute(t *testing.T) {
 	unregisterDefaults(defaultSubsystem)
 }
 
-// TestSetPathFor404Logic tests when the 404 response is due to logic, the url is included in the metric
+// TestSetPathFor404Logic tests that the url is included in the metric when the 404 response is due to logic
 func TestSetPathFor404Logic(t *testing.T) {
 	unregisterDefaults("myapp")
 	e := echo.New()
 
-	setPathFor404 := false
-	e.Use(NewMiddlewareWithConfig(MiddlewareConfig{SetPathFor404: &setPathFor404, Subsystem: defaultSubsystem}))
+	e.Use(NewMiddlewareWithConfig(MiddlewareConfig{DoNotUseURLFor404: true, Subsystem: defaultSubsystem}))
 	e.GET("/metrics", NewHandler())
 
 	e.GET("/sample", echo.NotFoundHandler)