Skip to content

serverutil: Serve metrics on dedicated mux #3845

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

Open
1seal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

serverutil: Serve metrics on dedicated mux #3845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
101 changes: 101 additions & 0 deletions cmd/internal/serverutil/http_server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
package serverutil_test

import (
"context"
"fmt"
"io"
"net"
"net/http"
"testing"
"time"

"github.com/google/trillian/cmd/internal/serverutil"
"github.com/google/trillian/extension"
"google.golang.org/grpc"

_ "net/http/pprof"
)

func pickFreePort(t *testing.T) int {
t.Helper()

ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("listen: %v", err)
}
defer ln.Close()

addr, ok := ln.Addr().(*net.TCPAddr)
if !ok {
t.Fatalf("unexpected addr type: %T", ln.Addr())
}
return addr.Port
}

func httpGetStatus(t *testing.T, url string) int {
t.Helper()

resp, err := http.Get(url) //nolint:gosec
if err != nil {
t.Fatalf("GET %s: %v", url, err)
}
defer resp.Body.Close()
_, _ = io.ReadAll(resp.Body)
return resp.StatusCode
}

func waitForStatus(t *testing.T, url string, want int) {
t.Helper()

deadline := time.Now().Add(3 * time.Second)
for time.Now().Before(deadline) {
resp, err := http.Get(url) //nolint:gosec
if err == nil {
_ = resp.Body.Close()
if resp.StatusCode == want {
return
}
}
time.Sleep(50 * time.Millisecond)
}
t.Fatalf("timeout waiting for %d from %s", want, url)
}

func TestHTTPServerDoesNotExposeDefaultServeMux(t *testing.T) {
httpPort := pickFreePort(t)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)

m := &serverutil.Main{
RPCEndpoint: "127.0.0.1:0",
HTTPEndpoint: fmt.Sprintf("127.0.0.1:%d", httpPort),
DBClose: func() error { return nil },
Registry: extension.Registry{},
RegisterServerFn: func(_ *grpc.Server, _ extension.Registry) error {
return nil
},
}

errCh := make(chan error, 1)
go func() {
errCh <- m.Run(ctx)
}()

baseURL := fmt.Sprintf("http://127.0.0.1:%d", httpPort)
waitForStatus(t, baseURL+"/healthz", http.StatusOK)

if got := httpGetStatus(t, baseURL+"/metrics"); got != http.StatusOK {
t.Fatalf("expected 200 from /metrics, got %d", got)
}

if got := httpGetStatus(t, baseURL+"/debug/pprof/"); got != http.StatusNotFound {
t.Fatalf("expected 404 from /debug/pprof/, got %d", got)
}

cancel()
select {
case <-time.After(5 * time.Second):
t.Fatalf("timeout waiting for server shutdown")
case <-errCh:
}
}
8 changes: 5 additions & 3 deletions cmd/internal/serverutil/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,13 @@ func (m *Main) Run(ctx context.Context) error {
g, ctx := errgroup.WithContext(ctx)

if endpoint := m.HTTPEndpoint; endpoint != "" {
http.Handle("/metrics", promhttp.Handler())
http.HandleFunc("/healthz", m.healthz)
mux := http.NewServeMux()
mux.Handle("/metrics", promhttp.Handler())
mux.HandleFunc("/healthz", m.healthz)

s := &http.Server{
Addr: endpoint,
Addr: endpoint,
Handler: mux,
}

run := func() error {
Expand Down