api/server: Server.CreateMux: pass context and use structured logs

Pass the context that's used for logging, and add minimal handling of context-cancellation. Also update logs to use structured fields. Before this patch: DEBU[2024-12-08T15:24:47.324420709Z] Registering POST, /networks/{id:.*}/disconnect DEBU[2024-12-08T15:24:47.324447251Z] Registering POST, /networks/prune DEBU[2024-12-08T15:24:47.324460626Z] Registering DELETE, /networks/{id:.*} With this patch: DEBU[2024-12-08T15:33:50.408445543Z] Registering route method=POST path="/networks/{id:.*}/disconnect" DEBU[2024-12-08T15:33:50.408484335Z] Registering route method=POST path=/networks/prune DEBU[2024-12-08T15:33:50.408505251Z] Registering route method=DELETE path="/networks/{id:.*}" Or in JSON format: {"level":"debug","method":"POST","msg":"Registering route","path":"/networks/{id:.*}/connect","time":"2024-12-08T15:37:19.235209667Z"} {"level":"debug","method":"POST","msg":"Registering route","path":"/networks/{id:.*}/disconnect","time":"2024-12-08T15:37:19.235243001Z"} {"level":"debug","method":"POST","msg":"Registering route","path":"/networks/prune","time":"2024-12-08T15:37:19.235290876Z"} Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
vvoland · Dec 9, 2024 · 9da0e69 · 9da0e69
1 parent 9c1ff09
commit 9da0e69
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/api/server/server.go b/api/server/server.go
@@ -65,15 +65,16 @@ func (s *Server) makeHTTPHandler(handler httputils.APIFunc, operation string) ht
 }
 
 // CreateMux returns a new mux with all the routers registered.
-func (s *Server) CreateMux(routers ...router.Router) *mux.Router {
+func (s *Server) CreateMux(ctx context.Context, routers ...router.Router) *mux.Router {
+	log.G(ctx).Debug("Registering routers")
 	m := mux.NewRouter()
-
-	log.G(context.TODO()).Debug("Registering routers")
 	for _, apiRouter := range routers {
 		for _, r := range apiRouter.Routes() {
+			if ctx.Err() != nil {
+				return m
+			}
+			log.G(ctx).WithFields(log.Fields{"method": r.Method(), "path": r.Path()}).Debug("Registering route")
 			f := s.makeHTTPHandler(r.Handler(), r.Method()+" "+r.Path())
-
-			log.G(context.TODO()).Debugf("Registering %s, %s", r.Method(), r.Path())
 			m.Path(versionMatcher + r.Path()).Methods(r.Method()).Handler(f)
 			m.Path(r.Path()).Methods(r.Method()).Handler(f)
 		}

diff --git a/cmd/dockerd/daemon.go b/cmd/dockerd/daemon.go
@@ -307,7 +307,7 @@ func (cli *daemonCLI) start(ctx context.Context) (err error) {
 	}
 
 	routers := buildRouters(routerOpts)
-	httpServer.Handler = apiServer.CreateMux(routers...)
+	httpServer.Handler = apiServer.CreateMux(ctx, routers...)
 
 	go d.ProcessClusterNotifications(ctx, c.GetWatchStream())