From 2b9cf56f565517b947b0eb71d2086764e9edf2be Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Thu, 23 Nov 2023 19:10:51 +0100 Subject: [chore/bugfix] Fix double gzip on prometheus endpoint (#2383) * [chore] Move "/metrics" into separate API module * use our own gzip middleware for prom --- internal/api/metrics.go | 66 +++++++++++++++++++++++++++++++++++++++++ internal/api/metrics/metrics.go | 54 +++++++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+) create mode 100644 internal/api/metrics.go create mode 100644 internal/api/metrics/metrics.go (limited to 'internal/api') diff --git a/internal/api/metrics.go b/internal/api/metrics.go new file mode 100644 index 000000000..5d97b9610 --- /dev/null +++ b/internal/api/metrics.go @@ -0,0 +1,66 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package api + +import ( + "github.com/gin-gonic/gin" + "github.com/superseriousbusiness/gotosocial/internal/api/metrics" + "github.com/superseriousbusiness/gotosocial/internal/config" + "github.com/superseriousbusiness/gotosocial/internal/middleware" + "github.com/superseriousbusiness/gotosocial/internal/router" +) + +type Metrics struct { + metrics *metrics.Module +} + +func (mt *Metrics) Route(r *router.Router, m ...gin.HandlerFunc) { + if !config.GetMetricsEnabled() { + // Noop: metrics + // not enabled. + return + } + + // Create new group on top level "metrics" prefix. + metricsGroup := r.AttachGroup("metrics") + metricsGroup.Use(m...) + metricsGroup.Use( + middleware.CacheControl(middleware.CacheControlConfig{ + // Never cache metrics responses. + Directives: []string{"no-store"}, + }), + ) + + // Attach basic auth if enabled. + if config.GetMetricsAuthEnabled() { + var ( + username = config.GetMetricsAuthUsername() + password = config.GetMetricsAuthPassword() + accounts = gin.Accounts{username: password} + ) + metricsGroup.Use(gin.BasicAuth(accounts)) + } + + mt.metrics.Route(metricsGroup.Handle) +} + +func NewMetrics() *Metrics { + return &Metrics{ + metrics: metrics.New(), + } +} diff --git a/internal/api/metrics/metrics.go b/internal/api/metrics/metrics.go new file mode 100644 index 000000000..d89e56ad5 --- /dev/null +++ b/internal/api/metrics/metrics.go @@ -0,0 +1,54 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package metrics + +import ( + "net/http" + + "github.com/gin-gonic/gin" + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/promhttp" +) + +type Module struct { + handler http.Handler +} + +func New() *Module { + // Use our own gzip handler. + opts := promhttp.HandlerOpts{ + DisableCompression: true, + } + + // Instrument handler itself. + handler := promhttp.InstrumentMetricHandler( + prometheus.DefaultRegisterer, + promhttp.HandlerFor(prometheus.DefaultGatherer, opts), + ) + + return &Module{ + handler: handler, + } +} + +func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) { + attachHandler(http.MethodGet, "", func(c *gin.Context) { + // Defer all "/metrics" handling to prom. + m.handler.ServeHTTP(c.Writer, c.Request) + }) +} -- cgit v1.2.3