go-promhttp

go-promhttp provides wrappers around the http package objects for monitoring with Prometheus, namely the http.Client, and http.Handler.

Requirements

minimum golang version of 1.9

Wrapping the http.Client

For example, you can instrument your http requests sent using the promhttp.Client as follows:

httpClient := &promhttp.Client{
	Client: http.DefaultClient,
	Registerer: prometheus.DefaultRegister,
}
githubClient, _ := httpClient.ForRecipient("github")

resp, err := githubClient.Get("https://api.github.com/repos/travelaudience/go-promhttp/issues")
...

Doing so will give you prometheus metrics such as:

By calling httpClient.ForRecipient("github"), all of these metrics will be tagged with the label "recipient": "github"

Wrapping the http.Handler

Simmilarly, a http.Handler can be instrumented for monitoring via the promhttp.ServeMux. By running the following code,

mux := &promhttp.ServeMux {
	ServeMux: &http.ServeMux{}
}

mux.Handle("/issues", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
	...
}))

we have the mux handle incoming requests and generating metrics. The metrics generated are as follows:

And all of these metrics in our example would have the label "path": "/issues".

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the MIT License - see the LICENSE file for details