Move Prom metrics to a dedicated port + improve Helm chart (#599)

internal/cli/main.go

@@ -9,6 +9,7 @@ import (
 	"github.com/thomiceli/opengist/internal/git"
 	"github.com/thomiceli/opengist/internal/index"
 	"github.com/thomiceli/opengist/internal/ssh"
+	"github.com/thomiceli/opengist/internal/web/handlers/metrics"
 	"github.com/thomiceli/opengist/internal/web/server"
 	"github.com/urfave/cli/v2"
 	"os"
@@ -36,12 +37,18 @@ var CmdStart = cli.Command{
 
 		Initialize(ctx)
 
-		server := server.NewServer(os.Getenv("OG_DEV") == "1", path.Join(config.GetHomeDir(), "sessions"), false)
-		go server.Start()
+		httpServer := server.NewServer(os.Getenv("OG_DEV") == "1", path.Join(config.GetHomeDir(), "sessions"), false)
+		go httpServer.Start()
 		go ssh.Start()
 
+		var metricsServer *metrics.Server
+		if config.C.MetricsEnabled {
+			metricsServer = metrics.NewServer()
+			go metricsServer.Start()
+		}
+
 		<-stopCtx.Done()
-		shutdown(server)
+		shutdown(httpServer, metricsServer)
 		return nil
 	},
 }
@@ -131,7 +138,7 @@ func Initialize(ctx *cli.Context) {
 	}
 }
 
-func shutdown(server *server.Server) {
+func shutdown(httpServer *server.Server, metricsServer *metrics.Server) {
 	log.Info().Msg("Shutting down database...")
 	if err := db.Close(); err != nil {
 		log.Error().Err(err).Msg("Failed to close database")
@@ -142,7 +149,11 @@ func shutdown(server *server.Server) {
 		index.Close()
 	}
 
-	server.Stop()
+	httpServer.Stop()
+
+	if metricsServer != nil {
+		metricsServer.Stop()
+	}
 
 	log.Info().Msg("Shutdown complete")
 }

internal/config/config.go

@@ -79,7 +79,9 @@ type config struct {
 	OIDCGroupClaimName string `yaml:"oidc.group-claim-name" env:"OG_OIDC_GROUP_CLAIM_NAME"`
 	OIDCAdminGroup     string `yaml:"oidc.admin-group" env:"OG_OIDC_ADMIN_GROUP"`
 
-	MetricsEnabled bool `yaml:"metrics.enabled" env:"OG_METRICS_ENABLED"`
+	MetricsEnabled bool   `yaml:"metrics.enabled" env:"OG_METRICS_ENABLED"`
+	MetricsHost    string `yaml:"metrics.host" env:"OG_METRICS_HOST"`
+	MetricsPort    string `yaml:"metrics.port" env:"OG_METRICS_PORT"`
 
 	LDAPUrl             string `yaml:"ldap.url" env:"OG_LDAP_URL"`
 	LDAPBindDn          string `yaml:"ldap.bind-dn" env:"OG_LDAP_BIND_DN"`
@@ -128,6 +130,8 @@ func configWithDefaults() (*config, error) {
 	c.GiteaName = "Gitea"
 
 	c.MetricsEnabled = false
+	c.MetricsHost = "0.0.0.0"
+	c.MetricsPort = "6158"
 
 	return c, nil
 }

internal/web/handlers/metrics/metrics.go

@@ -1,16 +1,12 @@
 package metrics
 
 import (
-	"github.com/labstack/echo-contrib/echoprometheus"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
-	"github.com/thomiceli/opengist/internal/config"
 	"github.com/thomiceli/opengist/internal/db"
-	"github.com/thomiceli/opengist/internal/web/context"
 )
 
 var (
-	// Using promauto to automatically register metrics with the default registry
 	countUsersGauge   prometheus.Gauge
 	countGistsGauge   prometheus.Gauge
 	countSSHKeysGauge prometheus.Gauge
@@ -18,84 +14,52 @@ var (
 	metricsInitialized bool = false
 )
 
-// initMetrics initializes metrics if they're not already initialized
 func initMetrics() {
 	if metricsInitialized {
 		return
 	}
 
-	// Only initialize metrics if they're enabled
-	if config.C.MetricsEnabled {
-		countUsersGauge = promauto.NewGauge(
-			prometheus.GaugeOpts{
-				Name: "opengist_users_total",
-				Help: "Total number of users",
-			},
-		)
+	countUsersGauge = promauto.NewGauge(
+		prometheus.GaugeOpts{
+			Name: "opengist_users_total",
+			Help: "Total number of users",
+		},
+	)
 
-		countGistsGauge = promauto.NewGauge(
-			prometheus.GaugeOpts{
-				Name: "opengist_gists_total",
-				Help: "Total number of gists",
-			},
-		)
+	countGistsGauge = promauto.NewGauge(
+		prometheus.GaugeOpts{
+			Name: "opengist_gists_total",
+			Help: "Total number of gists",
+		},
+	)
 
-		countSSHKeysGauge = promauto.NewGauge(
-			prometheus.GaugeOpts{
-				Name: "opengist_ssh_keys_total",
-				Help: "Total number of SSH keys",
-			},
-		)
+	countSSHKeysGauge = promauto.NewGauge(
+		prometheus.GaugeOpts{
+			Name: "opengist_ssh_keys_total",
+			Help: "Total number of SSH keys",
+		},
+	)
 
-		metricsInitialized = true
-	}
+	metricsInitialized = true
 }
 
-// updateMetrics refreshes all metric values from the database
 func updateMetrics() {
-	// Only update metrics if they're enabled
-	if !config.C.MetricsEnabled || !metricsInitialized {
+	if !metricsInitialized {
 		return
 	}
 
-	// Update users count
 	countUsers, err := db.CountAll(&db.User{})
 	if err == nil {
 		countUsersGauge.Set(float64(countUsers))
 	}
 
-	// Update gists count
 	countGists, err := db.CountAll(&db.Gist{})
 	if err == nil {
 		countGistsGauge.Set(float64(countGists))
 	}
 
-	// Update SSH keys count
 	countKeys, err := db.CountAll(&db.SSHKey{})
 	if err == nil {
 		countSSHKeysGauge.Set(float64(countKeys))
 	}
 }
-
-// Metrics handles prometheus metrics endpoint requests.
-func Metrics(ctx *context.Context) error {
-	// If metrics are disabled, return 404
-	if !config.C.MetricsEnabled {
-		return ctx.NotFound("Metrics endpoint is disabled")
-	}
-
-	// Initialize metrics if not already done
-	initMetrics()
-
-	// Update metrics
-	updateMetrics()
-
-	// Get the Echo context
-	echoCtx := ctx.Context
-
-	// Use the Prometheus metrics handler
-	handler := echoprometheus.NewHandler()
-
-	// Call the handler
-	return handler(echoCtx)
-}

internal/web/handlers/metrics/server.go

@@ -0,0 +1,50 @@
+package metrics
+
+import (
+	"net/http"
+
+	"github.com/labstack/echo-contrib/echoprometheus"
+	"github.com/labstack/echo/v4"
+	"github.com/rs/zerolog/log"
+	"github.com/thomiceli/opengist/internal/config"
+)
+
+type Server struct {
+	echo *echo.Echo
+}
+
+func NewServer() *Server {
+	e := echo.New()
+	e.HideBanner = true
+	e.HidePort = true
+
+	s := &Server{echo: e}
+
+	initMetrics()
+
+	e.GET("/metrics", func(ctx echo.Context) error {
+		updateMetrics()
+		return echoprometheus.NewHandler()(ctx)
+	})
+
+	return s
+}
+
+func (s *Server) Start() {
+	addr := config.C.MetricsHost + ":" + config.C.MetricsPort
+	log.Info().Msg("Starting metrics server on http://" + addr)
+	if err := s.echo.Start(addr); err != nil && err != http.ErrServerClosed {
+		log.Error().Err(err).Msg("Failed to start metrics server")
+	}
+}
+
+func (s *Server) Stop() {
+	log.Info().Msg("Stopping metrics server...")
+	if err := s.echo.Close(); err != nil {
+		log.Error().Err(err).Msg("Failed to stop metrics server")
+	}
+}
+
+func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	s.echo.ServeHTTP(w, r)
+}

internal/web/server/middlewares.go

@@ -37,8 +37,7 @@ func (s *Server) registerMiddlewares() {
 	s.echo.Use(Middleware(dataInit).toEcho())
 	s.echo.Use(Middleware(locale).toEcho())
 	if config.C.MetricsEnabled {
-		p := echoprometheus.NewMiddleware("opengist")
-		s.echo.Use(p)
+		s.echo.Use(echoprometheus.NewMiddleware("opengist"))
 	}
 
 	s.echo.Pre(middleware.MethodOverrideWithConfig(middleware.MethodOverrideConfig{

internal/web/server/router.go

@@ -17,7 +17,6 @@ import (
 	"github.com/thomiceli/opengist/internal/web/handlers/gist"
 	"github.com/thomiceli/opengist/internal/web/handlers/git"
 	"github.com/thomiceli/opengist/internal/web/handlers/health"
-	"github.com/thomiceli/opengist/internal/web/handlers/metrics"
 	"github.com/thomiceli/opengist/internal/web/handlers/settings"
 	"github.com/thomiceli/opengist/public"
 )
@@ -34,10 +33,6 @@ func (s *Server) registerRoutes() {
 
 		r.GET("/healthcheck", health.Healthcheck)
 
-		if config.C.MetricsEnabled {
-			r.GET("/metrics", metrics.Metrics)
-		}
-
 		r.GET("/register", auth.Register)
 		r.POST("/register", auth.ProcessRegister)
 		r.GET("/login", auth.Login)

internal/web/test/metrics_test.go

@@ -1,15 +1,15 @@
 package test
 
 import (
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-	"github.com/thomiceli/opengist/internal/db"
 	"io"
-	"net/http"
-	"os"
+	"net/http/httptest"
 	"strconv"
 	"strings"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/thomiceli/opengist/internal/db"
 )
 
 var (
@@ -41,22 +41,12 @@ var (
 // - Total number of SSH keys
 //
 // The test follows these steps:
-// 1. Enables metrics via environment variable
-// 2. Sets up test environment
-// 3. Registers and logs in an admin user
-// 4. Creates a gist and adds an SSH key
-// 5. Queries the metrics endpoint
-// 6. Verifies the reported metrics match expected values
-//
-// Environment variables:
-//   - OG_METRICS_ENABLED: Set to "true" for this test
+// 1. Sets up test environment
+// 2. Registers and logs in an admin user
+// 3. Creates a gist and adds an SSH key
+// 4. Creates a metrics server and queries the /metrics endpoint
+// 5. Verifies the reported metrics match expected values
 func TestMetrics(t *testing.T) {
-	originalValue := os.Getenv("OG_METRICS_ENABLED")
-
-	os.Setenv("OG_METRICS_ENABLED", "true")
-
-	defer os.Setenv("OG_METRICS_ENABLED", originalValue)
-
 	s := Setup(t)
 	defer Teardown(t, s)
 
@@ -72,12 +62,16 @@ func TestMetrics(t *testing.T) {
 	err = s.Request("POST", "/settings/ssh-keys", SSHKey, 302)
 	require.NoError(t, err)
 
-	var metricsRes http.Response
-	err = s.Request("GET", "/metrics", nil, 200, &metricsRes)
-	require.NoError(t, err)
+	// Create a metrics server and query it
+	metricsServer := NewTestMetricsServer()
 
-	body, err := io.ReadAll(metricsRes.Body)
-	defer metricsRes.Body.Close()
+	req := httptest.NewRequest("GET", "/metrics", nil)
+	w := httptest.NewRecorder()
+	metricsServer.ServeHTTP(w, req)
+
+	require.Equal(t, 200, w.Code)
+
+	body, err := io.ReadAll(w.Body)
 	require.NoError(t, err)
 
 	lines := strings.Split(string(body), "\n")

internal/web/test/server.go

@@ -22,6 +22,7 @@ import (
 	"github.com/thomiceli/opengist/internal/config"
 	"github.com/thomiceli/opengist/internal/db"
 	"github.com/thomiceli/opengist/internal/git"
+	"github.com/thomiceli/opengist/internal/web/handlers/metrics"
 	"github.com/thomiceli/opengist/internal/web/server"
 )
 
@@ -240,3 +241,7 @@ type invitationAdmin struct {
 	nbMax         string `form:"nbMax"`
 	expiredAtUnix string `form:"expiredAtUnix"`
 }
+
+func NewTestMetricsServer() *metrics.Server {
+	return metrics.NewServer()
+}