Prometheus metrics exporter for Gin.Inspired by Depado/ginprom.
$ go get -u github.com/chenjiandongx/ginpromIt's easy to get started with ginprom, only a few lines of code needed.
import (
"github.com/chenjiandongx/ginprom"
"github.com/gin-gonic/gin"
"github.com/prometheus/client_golang/prometheus/promhttp"
)
func main() {
r := gin.Default()
// use prometheus metrics exporter middleware.
//
// ginprom.PromMiddleware() expects a ginprom.PromOpts{} poniter.
// It was used for filtering labels with regex. `nil` will pass every requests.
//
// ginprom promethues-labels:
// `status`, `endpoint`, `method`
//
// for example:
// 1). I want not to record the 404 status request. That's easy for it.
// ginprom.PromMiddleware(&ginprom.PromOpts{ExcludeRegexStatus: "404"})
//
// 2). And I wish to ignore endpoint start with `/prefix`.
// ginprom.PromMiddleware(&ginprom.PromOpts{ExcludeRegexEndpoint: "^/prefix"})
r.Use(ginprom.PromMiddleware(nil))
// register the `/metrics` route.
r.GET("/metrics", ginprom.PromHandler(promhttp.Handler()))
// your working routes
r.GET("/", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "home"})
})
}Details about exposed Prometheus metrics.
| Name | Type | Exposed Information |
|---|---|---|
| service_uptime | Counter | HTTP service uptime. |
| service_http_request_count_total | Counter | Total number of HTTP requests made. |
| service_http_request_duration_seconds | Histogram | HTTP request latencies in seconds. |
| service_http_request_size_bytes | Summary | HTTP request sizes in bytes. |
| service_http_response_size_bytes | Summary | HTTP request sizes in bytes. |
Although Promethues offers a simple dashboard, Grafana is clearly a better choice. Grafana configuration.
MIT ©chenjiandongx