Skip to content

prometheus middleware #14

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

Merged
kont-noor merged 2 commits into from
May 26, 2025
Merged

prometheus middleware #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58c2f11
prometheus middleware
kont-noor May 26, 2025
f051fe8
fix the tests
kont-noor May 26, 2025
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
1 change: 1 addition & 0 deletions compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ services:
- MONGO_URL=mongodb://mongo:mongo@mongo:27017
- MONGO_DB=connections
- MONGO_COLLECTION=connections
- PROMETHEUS_ENABLED=true
depends_on:
- mongo
client_1: &common_client
Expand Down
12 changes: 12 additions & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,24 @@ require (

require github.com/stretchr/testify v1.10.0

require (
github.com/beorn7/perks v1.0.1 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/prometheus/client_model v0.6.1 // indirect
github.com/prometheus/common v0.62.0 // indirect
github.com/prometheus/procfs v0.15.1 // indirect
golang.org/x/sys v0.32.0 // indirect
google.golang.org/protobuf v1.36.5 // indirect
)

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/golang/snappy v1.0.0 // indirect
github.com/klauspost/compress v1.18.0 // indirect
github.com/montanaflynn/stats v0.7.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/prometheus/client_golang v1.22.0
github.com/xdg-go/pbkdf2 v1.0.0 // indirect
github.com/xdg-go/scram v1.1.2 // indirect
github.com/xdg-go/stringprep v1.0.4 // indirect
Expand Down
18 changes: 18 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/golang/snappy v1.0.0 h1:Oy607GVXHs7RtbggtPBnr2RmDArIsAefDwvrdWvRhGs=
Expand All @@ -8,8 +12,18 @@ github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zt
github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ=
github.com/montanaflynn/stats v0.7.1 h1:etflOAAHORrCC44V+aR6Ftzort912ZU+YLiSTuV8eaE=
github.com/montanaflynn/stats v0.7.1/go.mod h1:etXPPgVO6n31NxCd9KQUMvCM+ve0ruNzt6R8Bnaayow=
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prometheus/client_golang v1.22.0 h1:rb93p9lokFEsctTys46VnV1kLCDpVZ0a/Y92Vm0Zc6Q=
github.com/prometheus/client_golang v1.22.0/go.mod h1:R7ljNsLXhuQXYZYtw6GAE9AZg8Y7vEW5scdCXrWRXC0=
github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E=
github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY=
github.com/prometheus/common v0.62.0 h1:xasJaQlnWAeyHdUBeGjXmutelfJHWMRr+Fg4QszZ2Io=
github.com/prometheus/common v0.62.0/go.mod h1:vyBcEuLSvWos9B1+CyL7JZ2up+uFzXhkqml0W5zIY1I=
github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0learggepc=
github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoGhij/e3PBqk=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/xdg-go/pbkdf2 v1.0.0 h1:Su7DPu48wXMwC3bs7MCNG+z4FhcyEuz5dlvchbq0B0c=
Expand Down Expand Up @@ -46,6 +60,8 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
Expand All @@ -58,6 +74,8 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/protobuf v1.36.5 h1:tPhr+woSbjfYvY6/GPufUoYizxw1cF/yFoxJ2fmpwlM=
google.golang.org/protobuf v1.36.5/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
Expand Down
63 changes: 63 additions & 0 deletions internal/metrics/middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package metrics

import (
"net/http"
"time"

"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
)

const (
metricsPath = "/metrics"
)

var httpRequestDuration = prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Name: "http_request_duration_seconds",
Help: "Duration of HTTP requests",
Buckets: prometheus.DefBuckets,
},
[]string{"path", "method"},
)

type Middleware struct {
enabled bool
}

func NewMiddleware(enabled bool) *Middleware {
if enabled {
prometheus.MustRegister(httpRequestDuration)
}

Check warning on line 31 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L28-L31 

Added lines #L28 - L31 were not covered by tests

return &Middleware{enabled: enabled}

Check warning on line 33 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L33 

Added line #L33 was not covered by tests
}

func (m *Middleware) Routes(router *http.ServeMux) {
if !m.enabled {
return
}

Check warning on line 39 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L36-L39 

Added lines #L36 - L39 were not covered by tests

router.Handle(metricsPath, promhttp.Handler())

Check warning on line 41 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L41 

Added line #L41 was not covered by tests
}

func (m *Middleware) Middleware(next http.Handler) http.Handler {
if !m.enabled {
return next
}

Check warning on line 47 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L44-L47 

Added lines #L44 - L47 were not covered by tests

return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
start := time.Now()
next.ServeHTTP(w, r)
m.observeDuration(start, r.URL.Path, r.Method)
})

Check warning on line 53 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L49-L53 

Added lines #L49 - L53 were not covered by tests
}

func (m *Middleware) observeDuration(start time.Time, path, method string) {
if !m.enabled {
return
}

Check warning on line 59 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L56-L59 

Added lines #L56 - L59 were not covered by tests

duration := time.Since(start).Seconds()
httpRequestDuration.WithLabelValues(path, method).Observe(duration)

Check warning on line 62 in internal/metrics/middleware.go

View check run for this annotation

Codecov / codecov/patch

internal/metrics/middleware.go#L61-L62 

Added lines #L61 - L62 were not covered by tests
}
22 changes: 17 additions & 5 deletions internal/router/router.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,15 @@ type APIHandlers interface {
Heartbeat(w http.ResponseWriter, r *http.Request)
}

type MetricsMiddleware interface {
Middleware(next http.Handler) http.Handler
Routes(router *http.ServeMux)
}

type Config struct {
APIHandlers APIHandlers
Log *zap.Logger
APIHandlers APIHandlers
MetricsMiddleware MetricsMiddleware
Log *zap.Logger
}

type ResponseWriterWrapper struct {
Expand Down Expand Up @@ -77,11 +83,17 @@ func healthCheckHandler(w http.ResponseWriter, r *http.Request) {
func New(config Config) *http.ServeMux {
router := http.NewServeMux()

router.Handle(apiPath+connectPath, LoggingMiddleware(config.Log, http.HandlerFunc(config.APIHandlers.Connect)))
router.Handle(apiPath+disconnectPath, LoggingMiddleware(config.Log, http.HandlerFunc(config.APIHandlers.Disconnect)))
router.Handle(apiPath+heartbeatPath, LoggingMiddleware(config.Log, http.HandlerFunc(config.APIHandlers.Heartbeat)))
router.Handle(apiPath+connectPath, applyMiddlewares(config, config.APIHandlers.Connect))
router.Handle(apiPath+disconnectPath, applyMiddlewares(config, config.APIHandlers.Disconnect))
router.Handle(apiPath+heartbeatPath, applyMiddlewares(config, config.APIHandlers.Heartbeat))

router.Handle(healthPath, http.HandlerFunc(healthCheckHandler))

config.MetricsMiddleware.Routes(router)

return router
}

func applyMiddlewares(config Config, handler func(w http.ResponseWriter, r *http.Request)) http.Handler {
return config.MetricsMiddleware.Middleware(LoggingMiddleware(config.Log, http.HandlerFunc(handler)))
}
11 changes: 7 additions & 4 deletions internal/router/router_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package router

import (
"bytes"
"connection_request_server/internal/metrics"
"net/http"
"testing"

Expand All @@ -16,8 +17,9 @@ func TestRouter(t *testing.T) {
log := zap.NewNop()

r := New(Config{
APIHandlers: mock,
Log: log,
APIHandlers: mock,
Log: log,
MetricsMiddleware: metrics.NewMiddleware(false),
})

tests := []struct {
Expand Down Expand Up @@ -47,8 +49,9 @@ func TestHealth(t *testing.T) {
log := zap.NewNop()

r := New(Config{
APIHandlers: mock,
Log: log,
APIHandlers: mock,
Log: log,
MetricsMiddleware: metrics.NewMiddleware(false),
})

req := httptest.NewRequest(http.MethodGet, "/health", bytes.NewBufferString(""))
Expand Down
11 changes: 10 additions & 1 deletion internal/server_app/server_app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
package serverapp

import (
"connection_request_server/internal/metrics"
adapter "connection_request_server/internal/mongo_adapter"
"connection_request_server/internal/router"
"connection_request_server/internal/service"
"connection_request_server/pkg/server"
"os"
"strconv"

"go.uber.org/zap"
)
Expand All @@ -31,7 +33,14 @@
logger.Sugar().Panicf("failed to create mongo client: %v, url: %s", err, mongoURL)
}
appService := service.New(service.Config{Repository: repositoryClient})
appRouter := router.New(router.Config{APIHandlers: appService, Log: logger})

enabledStr := os.Getenv("PROMETHEUS_ENABLED")
enabled, err := strconv.ParseBool(enabledStr)
if err != nil {
enabled = false
}
metricsMiddleware := metrics.NewMiddleware(enabled)
appRouter := router.New(router.Config{APIHandlers: appService, Log: logger, MetricsMiddleware: metricsMiddleware})

Check warning on line 43 in internal/server_app/server_app.go

View check run for this annotation

Codecov / codecov/patch

internal/server_app/server_app.go#L36-L43 

Added lines #L36 - L43 were not covered by tests

serverHostname := os.Getenv("SERVER_HOSTNAME")
serverPort := os.Getenv("SERVER_PORT")
Expand Down