Skip to content

Add log detail which handler processing request #425

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

Merged
miry merged 1 commit into from
Aug 28, 2022
Merged

Add log detail which handler processing request #425

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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
* Replace logrus with zerolog. (#413, @miry)
* Log HTTP requests to API server. (#413, #421, @miry)
* Add TimeoutHandler for the HTTP API server. (#420, @miry)
* Set Write and Read timeouts for HTTP API server connections. (@miry)
* Set Write and Read timeouts for HTTP API server connections. (#423, @miry)
* Show uniq request id in API HTTP response. (#425, @miry)

# [2.4.0] - 2022-03-07

Expand Down
49 changes: 32 additions & 17 deletions api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,37 +63,52 @@ func timeoutMiddleware(next http.Handler) http.Handler {
func (server *ApiServer) Listen(host string, port string) {
r := mux.NewRouter()
r.Use(hlog.NewHandler(*server.Logger))
r.Use(hlog.RequestIDHandler("request_id", ""))
r.Use(hlog.RequestIDHandler("request_id", "X-Toxiproxy-Request-Id"))
r.Use(hlog.AccessHandler(func(r *http.Request, status, size int, duration time.Duration) {
hlog.FromRequest(r).Debug().
handler := mux.CurrentRoute(r).GetName()
zerolog.Ctx(r.Context()).
Debug().
Str("client", r.RemoteAddr).
Str("method", r.Method).
Stringer("url", r.URL).
Int("status", status).
Int("size", size).
Dur("duration", duration).
Str("handler", handler).
Msg("")
}))
r.Use(stopBrowsersMiddleware)
r.Use(timeoutMiddleware)

r.HandleFunc("/reset", server.ResetState).Methods("POST")
r.HandleFunc("/proxies", server.ProxyIndex).Methods("GET")
r.HandleFunc("/proxies", server.ProxyCreate).Methods("POST")
r.HandleFunc("/populate", server.Populate).Methods("POST")
r.HandleFunc("/proxies/{proxy}", server.ProxyShow).Methods("GET")
r.HandleFunc("/proxies/{proxy}", server.ProxyUpdate).Methods("POST")
r.HandleFunc("/proxies/{proxy}", server.ProxyDelete).Methods("DELETE")
r.HandleFunc("/proxies/{proxy}/toxics", server.ToxicIndex).Methods("GET")
r.HandleFunc("/proxies/{proxy}/toxics", server.ToxicCreate).Methods("POST")
r.HandleFunc("/proxies/{proxy}/toxics/{toxic}", server.ToxicShow).Methods("GET")
r.HandleFunc("/proxies/{proxy}/toxics/{toxic}", server.ToxicUpdate).Methods("POST")
r.HandleFunc("/proxies/{proxy}/toxics/{toxic}", server.ToxicDelete).Methods("DELETE")

r.HandleFunc("/version", server.Version).Methods("GET")
r.HandleFunc("/reset", server.ResetState).Methods("POST").
Name("ResetState")
r.HandleFunc("/proxies", server.ProxyIndex).Methods("GET").
Name("ProxyIndex")
r.HandleFunc("/proxies", server.ProxyCreate).Methods("POST").
Name("ProxyCreate")
r.HandleFunc("/populate", server.Populate).Methods("POST").
Name("Populate")
r.HandleFunc("/proxies/{proxy}", server.ProxyShow).Methods("GET").
Name("ProxyShow")
r.HandleFunc("/proxies/{proxy}", server.ProxyUpdate).Methods("POST").
Name("ProxyUpdate")
r.HandleFunc("/proxies/{proxy}", server.ProxyDelete).Methods("DELETE").
Name("ProxyDelete")
r.HandleFunc("/proxies/{proxy}/toxics", server.ToxicIndex).Methods("GET").
Name("ToxicIndex")
r.HandleFunc("/proxies/{proxy}/toxics", server.ToxicCreate).Methods("POST").
Name("ToxicCreate")
r.HandleFunc("/proxies/{proxy}/toxics/{toxic}", server.ToxicShow).Methods("GET").
Name("ToxicShow")
r.HandleFunc("/proxies/{proxy}/toxics/{toxic}", server.ToxicUpdate).Methods("POST").
Name("ToxicUpdate")
r.HandleFunc("/proxies/{proxy}/toxics/{toxic}", server.ToxicDelete).Methods("DELETE").
Name("ToxicDelete")

r.HandleFunc("/version", server.Version).Methods("GET").Name("Version")

if server.Metrics.anyMetricsEnabled() {
r.Handle("/metrics", server.Metrics.handler())
r.Handle("/metrics", server.Metrics.handler()).Name("Metrics")
}

server.Logger.
Expand Down
18 changes: 18 additions & 0 deletions api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ func WithServer(t *testing.T, f func(string)) {

f("http://localhost:8475")
}
func TestRequestId(t *testing.T) {
WithServer(t, func(addr string) {
client := http.Client{}

req, _ := http.NewRequest("GET", "http://localhost:8475/version", nil)
req.Header.Add("User-Agent", "curl")

resp, err := client.Do(req)
if err != nil {
t.Fatalf("Does not expect errors from client: %+v", err)
}
defer resp.Body.Close()

if _, ok := resp.Header["X-Toxiproxy-Request-Id"]; !ok {
t.Fatalf("Expect http response with header X-Toxiproxy-Request-Id, got %+v", resp.Header)
}
})
}

func TestBrowserGets403(t *testing.T) {
WithServer(t, func(addr string) {
Expand Down