mirror of
https://github.com/prometheus/alertmanager.git
synced 2026-02-05 15:45:34 +01:00
5362823d7a
* Fix pprof endpoints not working with --web.route-prefix When using --web.route-prefix or --web.external-url with a path component, the pprof debug endpoints were not accessible. The handlers were directly passing requests to http.DefaultServeMux without adjusting the URL path to match what the pprof handlers expect. For example, with --web.route-prefix=/prometheus/alertmanager, a request to /prometheus/alertmanager/debug/pprof/ was being forwarded with the full path intact, but http.DefaultServeMux only has handlers registered for paths starting with /debug/pprof/. This fix reconstructs the request path by extracting the subpath parameter from the route and prepending /debug to it, ensuring the path matches what http.DefaultServeMux expects. The fix also preserves trailing slashes which are required by some pprof handlers. Added unit tests to verify pprof endpoints work correctly both with and without route prefix configuration. Co-authored-by: Claude <noreply@anthropic.com> Signed-off-by: Will Hegedus <whegedus@akamai.com> * chore: update ui/web_test.go copyright header Co-authored-by: Siavash Safi <git@hosted.run> Signed-off-by: Will Hegedus <whegedus@akamai.com> * chore: update ui/web.go copyright header Signed-off-by: Will Hegedus <whegedus@akamai.com> * test: Use testify for new ui/web_test.go tests Updated based on PR comments to conform with existing testing patterns Signed-off-by: Will Hegedus <whegedus@akamai.com> * test: modify test for pprof handler to check response body Signed-off-by: Will Hegedus <will@wbhegedus.me> --------- Signed-off-by: Will Hegedus <whegedus@akamai.com> Signed-off-by: Will Hegedus <will@wbhegedus.me> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Siavash Safi <git@hosted.run>
62 lines
2.0 KiB
Go
62 lines
2.0 KiB
Go
// Copyright The Prometheus Authors
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package ui
|
|
|
|
import (
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/prometheus/common/route"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestDebugHandlersWithRoutePrefix(t *testing.T) {
|
|
logger := slog.New(slog.NewTextHandler(os.Stderr, nil))
|
|
reloadCh := make(chan chan error)
|
|
|
|
// Test with route prefix
|
|
routePrefix := "/prometheus/alertmanager"
|
|
router := route.New().WithPrefix(routePrefix)
|
|
Register(router, reloadCh, logger)
|
|
|
|
// Test GET request to pprof index (note: pprof index returns text/html)
|
|
req := httptest.NewRequest("GET", routePrefix+"/debug/pprof/", nil)
|
|
w := httptest.NewRecorder()
|
|
router.ServeHTTP(w, req)
|
|
|
|
require.Equal(t, http.StatusOK, w.Code)
|
|
require.Contains(t, w.Body.String(), "/debug/pprof/", "pprof page did not load with expected content when using a route prefix")
|
|
|
|
// Test GET request to pprof heap endpoint
|
|
req = httptest.NewRequest("GET", routePrefix+"/debug/pprof/heap", nil)
|
|
w = httptest.NewRecorder()
|
|
router.ServeHTTP(w, req)
|
|
|
|
require.Equal(t, http.StatusOK, w.Code)
|
|
|
|
// Test without route prefix (should also work)
|
|
router2 := route.New()
|
|
Register(router2, reloadCh, logger)
|
|
|
|
req = httptest.NewRequest("GET", "/debug/pprof/", nil)
|
|
w = httptest.NewRecorder()
|
|
router2.ServeHTTP(w, req)
|
|
|
|
require.Equal(t, http.StatusOK, w.Code)
|
|
require.Contains(t, w.Body.String(), "/debug/pprof/", "pprof page did not load with expected content")
|
|
}
|