fix(metrics): add timeouts to metrics HTTP server (#7469)

Add ReadTimeout, WriteTimeout, and IdleTimeout (5s each) to metrics HTTP
server and test to verify timeout behavior prevents hanging connections.

Signed-off-by: Ville Vesilehto <ville@vesilehto.fi>
This commit is contained in:
Ville Vesilehto
2025-08-29 06:03:55 +03:00
committed by GitHub
parent c38c2ca66f
commit 5a6700c39c
2 changed files with 53 additions and 1 deletions

View File

@@ -98,7 +98,12 @@ func (m *Metrics) OnStartup() error {
m.mux.Handle("/metrics", promhttp.HandlerFor(m.Reg, promhttp.HandlerOpts{}))
// creating some helper variables to avoid data races on m.srv and m.ln
server := &http.Server{Handler: m.mux}
server := &http.Server{
Handler: m.mux,
ReadTimeout: 5 * time.Second,
WriteTimeout: 5 * time.Second,
IdleTimeout: 5 * time.Second,
}
m.srv = server
go func() {

View File

@@ -2,7 +2,9 @@ package metrics
import (
"context"
"net"
"testing"
"time"
"github.com/coredns/coredns/plugin"
"github.com/coredns/coredns/plugin/pkg/dnstest"
@@ -80,3 +82,48 @@ func TestMetrics(t *testing.T) {
}
}
}
func TestMetricsHTTPTimeout(t *testing.T) {
met := New("localhost:0")
if err := met.OnStartup(); err != nil {
t.Fatalf("Failed to start metrics handler: %s", err)
}
defer met.OnFinalShutdown()
// Use context with timeout to prevent test from hanging indefinitely
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
done := make(chan error, 1)
go func() {
conn, err := net.Dial("tcp", ListenAddr)
if err != nil {
done <- err
return
}
defer conn.Close()
// Send partial HTTP request and then stop sending data
// This will cause the server to wait for more data and hit ReadTimeout
partialRequest := "GET /metrics HTTP/1.1\r\nHost: " + ListenAddr + "\r\nContent-Length: 100\r\n\r\n"
_, err = conn.Write([]byte(partialRequest))
if err != nil {
done <- err
return
}
// Now just wait - server should timeout trying to read the remaining data
// If server has no ReadTimeout, this will hang indefinitely
buffer := make([]byte, 1024)
_, err = conn.Read(buffer)
done <- err
}()
select {
case <-done:
t.Log("HTTP request timed out by server")
case <-ctx.Done():
t.Error("HTTP request did not time out")
}
}