Prometheus Middleware

Prometheus middleware generates metrics for HTTP requests.

Usage

  1. package main
  2. import (
  3.     "github.com/labstack/echo/v4"
  4.     "github.com/labstack/echo-contrib/prometheus"
  5. )
  6. func main() {
  7.     e := echo.New()
  8.     // Enable metrics middleware
  9.     p := prometheus.NewPrometheus("echo", nil)
  10.     p.Use(e)
  12.     e.Logger.Fatal(e.Start(":1323"))
  13. }

Sample Output

  1. curl http://localhost:1323/metrics
  3. # HELP echo_request_duration_seconds The HTTP request latencies in seconds.
  4. # TYPE echo_request_duration_seconds summary
  5. echo_request_duration_seconds_sum 0.41086482
  6. echo_request_duration_seconds_count 1
  7. # HELP echo_request_size_bytes The HTTP request sizes in bytes.
  8. # TYPE echo_request_size_bytes summary
  9. echo_request_size_bytes_sum 56
  10. echo_request_size_bytes_count 1
  11. # HELP echo_requests_total How many HTTP requests processed, partitioned by status code and HTTP method.
  12. # TYPE echo_requests_total counter
  13. echo_requests_total{code="200",host="localhost:8080",method="GET",url="/"} 1
  14. # HELP echo_response_size_bytes The HTTP response sizes in bytes.
  15. # TYPE echo_response_size_bytes summary
  16. echo_response_size_bytes_sum 61
  17. echo_response_size_bytes_count 1
  18. ...

Custom Configuration

Usage

A middleware skipper can be passed to avoid generating metrics to certain URLs:

  1. package main
  2. import (
  3.     "github.com/labstack/echo/v4"
  4.     "github.com/labstack/echo-contrib/prometheus"
  5. )
  7. // urlSkipper ignores metrics route on some middleware
  8. func urlSkipper(c echo.Context) bool {
  9.     if strings.HasPrefix(c.Path(), "/testurl") {
  10.         return true
  11.     }
  12.     return false
  13. }
  15. func main() {
  16.     e := echo.New()
  17.     // Enable metrics middleware
  18.     p := prometheus.NewPrometheus("echo", urlSkipper)
  19.     p.Use(e)
  21.     e.Logger.Fatal(e.Start(":1323"))
  22. }