Skip to content

Commit 46f43dc

Browse files
committed
Return to the past API so we don't break all libraries/framework implementations
Signed-off-by: Xabier Larrakoetxea <[email protected]>
1 parent b0c7418 commit 46f43dc

27 files changed

+54
-54
lines changed

examples/custom/main.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ func main() {
5151
// Wrape our middleware on each of the different handlers with the ID of the handler
5252
// this way we reduce the cardinality, for example: `/test/2` and `/test/4` will
5353
// have the same `handler` label on the metric: `/test/:testID`
54-
mux.Handle("/", std.Measure("/", mdlw, rooth))
55-
mux.Handle("/test/1", std.Measure("/test/:testID", mdlw, testh))
56-
mux.Handle("/test/2", std.Measure("/test/:testID", mdlw, testh2))
57-
mux.Handle("/other-test", std.Measure("/other-test", mdlw, othetesth))
54+
mux.Handle("/", std.Handler("/", mdlw, rooth))
55+
mux.Handle("/test/1", std.Handler("/test/:testID", mdlw, testh))
56+
mux.Handle("/test/2", std.Handler("/test/:testID", mdlw, testh2))
57+
mux.Handle("/other-test", std.Handler("/other-test", mdlw, othetesth))
5858

5959
// Serve our handler.
6060
go func() {

examples/default/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func main() {
4646

4747
// Wrap our main handler, we pass empty handler ID so the middleware inferes
4848
// the handler label from the URL.
49-
h := std.Measure("", mdlw, mux)
49+
h := std.Handler("", mdlw, mux)
5050

5151
// Serve our handler.
5252
go func() {

examples/echo/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func main() {
2828

2929
// Create Echo instance and global middleware.
3030
e := echo.New()
31-
e.Use(echomiddleware.Measure("", mdlw))
31+
e.Use(echomiddleware.Handler("", mdlw))
3232

3333
// Add our handler.
3434
e.GET("/", func(c echo.Context) error {

examples/gin/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func main() {
2727

2828
// Create Gin engine and global middleware.
2929
engine := gin.New()
30-
engine.Use(ginmiddleware.Measure("", mdlw))
30+
engine.Use(ginmiddleware.Handler("", mdlw))
3131

3232
// Add our handler.
3333
engine.GET("/", func(c *gin.Context) {

examples/gorestful/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func main() {
2929
c := gorestful.NewContainer()
3030

3131
// Add the middleware for all routes.
32-
c.Filter(gorestfulmiddleware.Measure("", mdlw))
32+
c.Filter(gorestfulmiddleware.Handler("", mdlw))
3333

3434
// Add our handler.
3535
ws := &gorestful.WebService{}

examples/httprouter/main.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ func main() {
4646
r := httprouter.New()
4747

4848
// Add the middleware to each route.
49-
r.GET("/", httproutermiddleware.Measure("/", h, mdlw))
50-
r.GET("/test/:id", httproutermiddleware.Measure("/test/:id", h1, mdlw))
51-
r.GET("/test2/:id", httproutermiddleware.Measure("/test2/:id", h2, mdlw))
49+
r.GET("/", httproutermiddleware.Handler("/", h, mdlw))
50+
r.GET("/test/:id", httproutermiddleware.Handler("/test/:id", h1, mdlw))
51+
r.GET("/test2/:id", httproutermiddleware.Handler("/test2/:id", h2, mdlw))
5252

5353
// Serve our handler.
5454
go func() {

examples/negroni/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ func main() {
3636
n := negroni.Classic()
3737

3838
// Add the middleware to negroni.
39-
n.Use(negronimiddleware.Measure("", mdlw))
39+
n.Use(negronimiddleware.Handler("", mdlw))
4040

4141
// Finally set our router on negroni.
4242
n.UseHandler(mux)

examples/opencensus/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func main() {
5454

5555
// Wrap our main handler, we pass empty handler ID so the middleware inferes
5656
// the handler label from the URL.
57-
h := std.Measure("", mdlw, mux)
57+
h := std.Handler("", mdlw, mux)
5858

5959
// Serve our handler.
6060
go func() {

middleware/echo/echo.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import (
99
"github.com/slok/go-http-metrics/middleware"
1010
)
1111

12-
// Measure returns a Echo measure middleware.
13-
func Measure(handlerID string, m middleware.Middleware) echo.MiddlewareFunc {
12+
// Handler returns a Echo measuring middleware.
13+
func Handler(handlerID string, m middleware.Middleware) echo.MiddlewareFunc {
1414
return func(h echo.HandlerFunc) echo.HandlerFunc {
1515
return echo.HandlerFunc(func(c echo.Context) error {
1616
r := &reporter{c: c}

middleware/echo/echo_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func getTestHandler(statusCode int) echo.HandlerFunc {
2121
}
2222
}
2323

24-
func TestMiddlewareIntegration(t *testing.T) {
24+
func TestMiddleware(t *testing.T) {
2525
tests := map[string]struct {
2626
handlerID string
2727
statusCode int
@@ -65,7 +65,7 @@ func TestMiddlewareIntegration(t *testing.T) {
6565
// Create our echo instance with the middleware.
6666
mdlw := middleware.New(middleware.Config{Recorder: mr})
6767
e := echo.New()
68-
e.POST("/test", getTestHandler(test.statusCode), echoMiddleware.Measure("", mdlw))
68+
e.POST("/test", getTestHandler(test.statusCode), echoMiddleware.Handler("", mdlw))
6969

7070
// Make the request.
7171
resp := httptest.NewRecorder()

middleware/echo/example_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func Example_echoMiddleware() {
2727
h := func(c echo.Context) error {
2828
return c.String(http.StatusOK, "Hello world")
2929
}
30-
e.GET("/", h, echoMiddleware.Measure("", mdlw))
30+
e.GET("/", h, echoMiddleware.Handler("", mdlw))
3131

3232
// Serve metrics from the default prometheus registry.
3333
log.Printf("serving metrics at: %s", ":8081")

middleware/gin/example_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func Example_ginMiddleware() {
2727
h := func(c *gin.Context) {
2828
c.String(http.StatusOK, "Hello world")
2929
}
30-
engine.GET("/", ginmiddleware.Measure("", mdlw), h)
30+
engine.GET("/", ginmiddleware.Handler("", mdlw), h)
3131

3232
// Serve metrics from the default prometheus registry.
3333
log.Printf("serving metrics at: %s", ":8081")

middleware/gin/gin.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import (
1010
"github.com/slok/go-http-metrics/middleware"
1111
)
1212

13-
// Measure returns a Gin measure middleware.
14-
func Measure(handlerID string, m middleware.Middleware) gin.HandlerFunc {
13+
// Handler returns a Gin measuring middleware.
14+
func Handler(handlerID string, m middleware.Middleware) gin.HandlerFunc {
1515
return func(c *gin.Context) {
1616
r := &reporter{c: c}
1717
m.Measure(handlerID, r, func() {

middleware/gin/gin_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func getTestHandler(statusCode int) gin.HandlerFunc {
2121
}
2222
}
2323

24-
func TestMiddlewareIntegration(t *testing.T) {
24+
func TestMiddleware(t *testing.T) {
2525
tests := map[string]struct {
2626
handlerID string
2727
statusCode int
@@ -66,7 +66,7 @@ func TestMiddlewareIntegration(t *testing.T) {
6666
mdlw := middleware.New(middleware.Config{Recorder: mr})
6767
engine := gin.New()
6868
engine.POST("/test",
69-
ginmiddleware.Measure("", mdlw),
69+
ginmiddleware.Handler("", mdlw),
7070
getTestHandler(test.statusCode))
7171

7272
// Make the request.

middleware/gorestful/example_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ func Example_gorestfulMiddleware() {
2424
c := gorestful.NewContainer()
2525

2626
// Add the middleware for all routes.
27-
c.Filter(gorestfulmiddleware.Measure("", mdlw))
27+
c.Filter(gorestfulmiddleware.Handler("", mdlw))
2828

2929
// Add our handler,
3030
ws := &gorestful.WebService{}

middleware/gorestful/gorestful.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import (
1010
"github.com/slok/go-http-metrics/middleware"
1111
)
1212

13-
// Measure returns a gorestful measure middleware.
14-
func Measure(handlerID string, m middleware.Middleware) gorestful.FilterFunction {
13+
// Handler returns a gorestful measuring middleware.
14+
func Handler(handlerID string, m middleware.Middleware) gorestful.FilterFunction {
1515
return func(req *gorestful.Request, resp *gorestful.Response, chain *gorestful.FilterChain) {
1616
r := &reporter{req: req, resp: resp}
1717
m.Measure(handlerID, r, func() {

middleware/gorestful/gorestful_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func getTestHandler(statusCode int) gorestful.RouteFunction {
2121
})
2222
}
2323

24-
func TestMiddlewareIntegration(t *testing.T) {
24+
func TestMiddleware(t *testing.T) {
2525
tests := map[string]struct {
2626
handlerID string
2727
statusCode int
@@ -65,7 +65,7 @@ func TestMiddlewareIntegration(t *testing.T) {
6565
// Create our instance with the middleware.
6666
mdlw := middleware.New(middleware.Config{Recorder: mr})
6767
c := gorestful.NewContainer()
68-
c.Filter(gorestfulmiddleware.Measure("", mdlw))
68+
c.Filter(gorestfulmiddleware.Handler("", mdlw))
6969
ws := &gorestful.WebService{}
7070
ws.Produces(gorestful.MIME_JSON)
7171
ws.Route(ws.POST("/test").To(getTestHandler(test.statusCode)))

middleware/httprouter/example_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ func Example_httprouterMiddlewareByHandler() {
3232
Recorder: metrics.NewRecorder(metrics.Config{}),
3333
})
3434
// Add the middleware.
35-
r.GET("/test/:id", httproutermiddleware.Measure("/test/:id", myHandler, mdlw))
36-
r.GET("/test2/:id", httproutermiddleware.Measure("/test2/:id", myHandler, mdlw))
35+
r.GET("/test/:id", httproutermiddleware.Handler("/test/:id", myHandler, mdlw))
36+
r.GET("/test2/:id", httproutermiddleware.Handler("/test2/:id", myHandler, mdlw))
3737

3838
// Serve metrics from the default prometheus registry.
3939
log.Printf("serving metrics at: %s", ":8081")
@@ -76,7 +76,7 @@ func Example_httprouterMiddlewareOnRouter() {
7676
}()
7777

7878
// Wrap the router with the middleware.
79-
h := stdmiddleware.Measure("", mdlw, r)
79+
h := stdmiddleware.Handler("", mdlw, r)
8080

8181
// Serve our handler.
8282
log.Printf("listening at: %s", ":8080")

middleware/httprouter/httprouter.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ import (
1111
"github.com/slok/go-http-metrics/middleware/std"
1212
)
1313

14-
// Measure returns a httprouter.Handler measured middlware.
15-
func Measure(handlerID string, next httprouter.Handle, m middleware.Middleware) httprouter.Handle {
14+
// Handler returns a httprouter.Handler measuring middleware.
15+
func Handler(handlerID string, next httprouter.Handle, m middleware.Middleware) httprouter.Handle {
1616
return func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
1717
// Dummy handler to wrap httprouter Handle type
1818
h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
1919
next(w, r, p)
2020
})
2121

22-
std.Measure(handlerID, m, h).ServeHTTP(w, r)
22+
std.Handler(handlerID, m, h).ServeHTTP(w, r)
2323
}
2424
}

middleware/httprouter/httprouter_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func getTestHandler(statusCode int) httprouter.Handle {
2121
})
2222
}
2323

24-
func TestMiddlewareIntegration(t *testing.T) {
24+
func TestMiddleware(t *testing.T) {
2525
tests := map[string]struct {
2626
handlerID string
2727
statusCode int
@@ -65,7 +65,7 @@ func TestMiddlewareIntegration(t *testing.T) {
6565
// Create our instance with the middleware.
6666
mdlw := middleware.New(middleware.Config{Recorder: mr})
6767
r := httprouter.New()
68-
r.POST("/test", httproutermiddleware.Measure("", getTestHandler(test.statusCode), mdlw))
68+
r.POST("/test", httproutermiddleware.Handler("", getTestHandler(test.statusCode), mdlw))
6969

7070
// Make the request.
7171
resp := httptest.NewRecorder()

middleware/negroni/example_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func Example_negroniMiddleware() {
2929
Recorder: metrics.NewRecorder(metrics.Config{}),
3030
})
3131
// Add the middleware to negroni.
32-
n.Use(negronimiddleware.Measure("", mdlw))
32+
n.Use(negronimiddleware.Handler("", mdlw))
3333

3434
// Finally set our router on negroni.
3535
n.UseHandler(myHandler)

middleware/negroni/negroni.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ import (
1111
"github.com/slok/go-http-metrics/middleware/std"
1212
)
1313

14-
// Measure returns a Negroni measuring middleware from a Middleware instance.
15-
func Measure(handlerID string, m middleware.Middleware) negroni.Handler {
14+
// Handler returns a Negroni measuring middleware.
15+
func Handler(handlerID string, m middleware.Middleware) negroni.Handler {
1616
return negroni.HandlerFunc(func(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
17-
std.Measure(handlerID, m, next).ServeHTTP(rw, r)
17+
std.Handler(handlerID, m, next).ServeHTTP(rw, r)
1818
})
1919
}

middleware/negroni/negroni_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func getTestHandler(statusCode int) http.Handler {
2121
})
2222
}
2323

24-
func TestMiddlewareIntegration(t *testing.T) {
24+
func TestMiddleware(t *testing.T) {
2525
tests := map[string]struct {
2626
handlerID string
2727
statusCode int
@@ -65,7 +65,7 @@ func TestMiddlewareIntegration(t *testing.T) {
6565
// Create our negroni instance with the middleware.
6666
mdlw := middleware.New(middleware.Config{Recorder: mr})
6767
n := negroni.Classic()
68-
n.Use(negronimiddleware.Measure("", mdlw))
68+
n.Use(negronimiddleware.Handler("", mdlw))
6969
n.UseHandler(getTestHandler(test.statusCode))
7070

7171
// Make the request.

middleware/std/example_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func Example_stdMiddleware() {
2626
})
2727

2828
// Wrap our handler with the middleware.
29-
h := stdmiddleware.Measure("", mdlw, myHandler)
29+
h := stdmiddleware.Handler("", mdlw, myHandler)
3030

3131
// Serve metrics from the default prometheus registry.
3232
log.Printf("serving metrics at: %s", ":8081")

middleware/std/std.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import (
1010
"github.com/slok/go-http-metrics/middleware"
1111
)
1212

13-
// Measure returns an measured standard http.Handler.
14-
func Measure(handlerID string, m middleware.Middleware, h http.Handler) http.Handler {
13+
// Handler returns an measuring standard http.Handler.
14+
func Handler(handlerID string, m middleware.Middleware, h http.Handler) http.Handler {
1515
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
1616
wi := &responseWriterInterceptor{
1717
statusCode: http.StatusOK,

middleware/std/std_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ func getFakeHandler(statusCode int, responseBody string) http.Handler {
2020
})
2121
}
2222

23-
func TestMiddlewareIntegraation(t *testing.T) {
23+
func TestMiddleware(t *testing.T) {
2424
tests := map[string]struct {
2525
handlerID string
2626
body string
@@ -101,7 +101,7 @@ func TestMiddlewareIntegraation(t *testing.T) {
101101
// Make the request.
102102
test.config.Recorder = mr
103103
m := middleware.New(test.config)
104-
h := stdmiddleware.Measure(test.handlerID, m, getFakeHandler(test.statusCode, test.body))
104+
h := stdmiddleware.Handler(test.handlerID, m, getFakeHandler(test.statusCode, test.body))
105105
h.ServeHTTP(httptest.NewRecorder(), test.req)
106106

107107
mr.AssertExpectations(t)

test/integration/integration_test.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type handlerConfig struct {
3939
sleepDuration time.Duration
4040
}
4141

42-
func TestMiddleware(t *testing.T) {
42+
func TestMiddlewarePrometheus(t *testing.T) {
4343
tests := map[string]struct {
4444
handler func(m middleware.Middleware, hc []handlerConfig) http.Handler
4545
}{
@@ -142,7 +142,7 @@ func prepareHandlerSTD(m middleware.Middleware, hc []handlerConfig) http.Handler
142142
}
143143

144144
// Setup server and middleware.
145-
h := stdmiddleware.Measure("", m, mux)
145+
h := stdmiddleware.Handler("", m, mux)
146146

147147
return h
148148
}
@@ -167,7 +167,7 @@ func prepareHandlerNegroni(m middleware.Middleware, hc []handlerConfig) http.Han
167167

168168
// Setup server and middleware.
169169
n := negroni.Classic()
170-
n.Use(negronimiddleware.Measure("", m))
170+
n.Use(negronimiddleware.Handler("", m))
171171
n.UseHandler(mux)
172172

173173
return n
@@ -187,7 +187,7 @@ func prepareHandlerHTTPRouter(m middleware.Middleware, hc []handlerConfig) http.
187187
}
188188

189189
// Setup middleware on each of the routes.
190-
r.Handle(h.Method, h.Path, httproutermiddleware.Measure("", hr, m))
190+
r.Handle(h.Method, h.Path, httproutermiddleware.Handler("", hr, m))
191191
}
192192

193193
return r
@@ -196,7 +196,7 @@ func prepareHandlerHTTPRouter(m middleware.Middleware, hc []handlerConfig) http.
196196
func prepareHandlerGorestful(m middleware.Middleware, hc []handlerConfig) http.Handler {
197197
// Setup server and middleware.
198198
c := gorestful.NewContainer()
199-
c.Filter(gorestfulmiddleware.Measure("", m))
199+
c.Filter(gorestfulmiddleware.Handler("", m))
200200

201201
// Setup handlers.
202202
ws := &gorestful.WebService{}
@@ -217,7 +217,7 @@ func prepareHandlerGorestful(m middleware.Middleware, hc []handlerConfig) http.H
217217
func prepareHandlerGin(m middleware.Middleware, hc []handlerConfig) http.Handler {
218218
// Setup server and middleware.
219219
e := gin.New()
220-
e.Use(ginmiddleware.Measure("", m))
220+
e.Use(ginmiddleware.Handler("", m))
221221

222222
// Setup handlers.
223223
for _, h := range hc {
@@ -234,7 +234,7 @@ func prepareHandlerGin(m middleware.Middleware, hc []handlerConfig) http.Handler
234234
func prepareHandlerEcho(m middleware.Middleware, hc []handlerConfig) http.Handler {
235235
// Setup server and middleware.
236236
e := echo.New()
237-
e.Use(echomiddleware.Measure("", m))
237+
e.Use(echomiddleware.Handler("", m))
238238

239239
// Setup handlers.
240240
for _, h := range hc {

0 commit comments

Comments
 (0)