Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow a list of status codes to be ignored from metrics #57

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Allow a list of status codes to be ignored from metrics #57

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b656187
feat: accept list of status codes to ignore when reporting metrics in…
ddf89 Aug 11, 2024
645a671
remove go files for PR
ddf89 Aug 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"io/ioutil"
"net/http"
"os"
"slices"
"strconv"
"time"

Expand All @@ -17,6 +18,7 @@ import (
var defaultMetricPath = "/metrics"

// Standard default metrics
//
// counter, counter_vec, gauge, gauge_vec,
// histogram, histogram_vec, summary, summary_vec
var reqCnt = &Metric{
Expand Down Expand Up @@ -59,16 +61,16 @@ the cardinality of the request counter's "url" label, which might be required in
For instance, if for a "/customer/:name" route you don't want to generate a time series for every
possible customer name, you could use this function:

func(c *gin.Context) string {
url := c.Request.URL.Path
for _, p := range c.Params {
if p.Key == "name" {
url = strings.Replace(url, p.Value, ":name", 1)
break
func(c *gin.Context) string {
url := c.Request.URL.Path
for _, p := range c.Params {
if p.Key == "name" {
url = strings.Replace(url, p.Value, ":name", 1)
break
}
}
return url
}
return url
}

which would map "/customer/alice" and "/customer/bob" to their template "/customer/:name".
*/
Expand Down Expand Up @@ -343,20 +345,20 @@ func (p *Prometheus) registerMetrics(subsystem string) {

// Use adds the middleware to a gin engine.
func (p *Prometheus) Use(e *gin.Engine) {
e.Use(p.HandlerFunc())
e.Use(p.HandlerFunc(nil))
p.SetMetricsPath(e)
}

// UseWithAuth adds the middleware to a gin engine with BasicAuth.
func (p *Prometheus) UseWithAuth(e *gin.Engine, accounts gin.Accounts) {
e.Use(p.HandlerFunc())
e.Use(p.HandlerFunc(nil))
p.SetMetricsPathWithAuth(e, accounts)
}

// HandlerFunc defines handler function for middleware
func (p *Prometheus) HandlerFunc() gin.HandlerFunc {
func (p *Prometheus) HandlerFunc(ignoreCodes []int) gin.HandlerFunc {
return func(c *gin.Context) {
if c.Request.URL.Path == p.MetricsPath {
if c.Request.URL.Path == p.MetricsPath || c.Writer.Status() == http.StatusNotFound {
c.Next()
return
}
Expand All @@ -365,11 +367,14 @@ func (p *Prometheus) HandlerFunc() gin.HandlerFunc {
reqSz := computeApproximateRequestSize(c.Request)

c.Next()

status := strconv.Itoa(c.Writer.Status())
elapsed := float64(time.Since(start)) / float64(time.Second)
resSz := float64(c.Writer.Size())

if ignoreCodes != nil && slices.Contains(ignoreCodes, c.Writer.Status()) {
return
}

url := p.ReqCntURLLabelMappingFn(c)
// jlambert Oct 2018 - sidecar specific mod
if len(p.URLLabelFromContext) > 0 {
Expand Down