feat: add debug endpoint for single tailnet (#10485)

coadler · web-flow · commit e0afee1b8560 · 2023-11-13T17:14:12.000-06:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -955,6 +955,7 @@ func New(options *Options) *API {
 			)
 
 			r.Get("/coordinator", api.debugCoordinator)
+			r.Get("/tailnet", api.debugTailnet)
 			r.Get("/health", api.debugDeploymentHealth)
 			r.Get("/ws", (&healthcheck.WebsocketEchoServer{}).ServeHTTP)
 		})
diff --git a/coderd/coderdtest/swaggerparser.go b/coderd/coderdtest/swaggerparser.go
@@ -352,7 +352,8 @@ func assertProduce(t *testing.T, comment SwaggerComment) {
 			(comment.router == "/workspaceagents/me/startup" && comment.method == "post") ||
 			(comment.router == "/workspaceagents/me/startup/logs" && comment.method == "patch") ||
 			(comment.router == "/licenses/{id}" && comment.method == "delete") ||
-			(comment.router == "/debug/coordinator" && comment.method == "get") {
+			(comment.router == "/debug/coordinator" && comment.method == "get") ||
+			(comment.router == "/debug/tailnet" && comment.method == "get") {
 			return // Exception: HTTP 200 is returned without response entity
 		}
 
diff --git a/coderd/debug.go b/coderd/debug.go
@@ -23,6 +23,17 @@ func (api *API) debugCoordinator(rw http.ResponseWriter, r *http.Request) {
 	(*api.TailnetCoordinator.Load()).ServeHTTPDebug(rw, r)
 }
 
+// @Summary Debug Info Tailnet
+// @ID debug-info-tailnet
+// @Security CoderSessionToken
+// @Produce text/html
+// @Tags Debug
+// @Success 200
+// @Router /debug/tailnet [get]
+func (api *API) debugTailnet(rw http.ResponseWriter, r *http.Request) {
+	api.agentProvider.ServeHTTPDebug(rw, r)
+}
+
 // @Summary Debug Info Deployment Health
 // @ID debug-info-deployment-health
 // @Security CoderSessionToken
diff --git a/coderd/tailnet.go b/coderd/tailnet.go
@@ -21,6 +21,7 @@ import (
 
 	"cdr.dev/slog"
 	"github.com/coder/coder/v2/coderd/tracing"
+	"github.com/coder/coder/v2/coderd/workspaceapps"
 	"github.com/coder/coder/v2/coderd/wsconncache"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/site"
@@ -38,6 +39,8 @@ func init() {
 	}
 }
 
+var _ workspaceapps.AgentProvider = (*ServerTailnet)(nil)
+
 // NewServerTailnet creates a new tailnet intended for use by coderd. It
 // automatically falls back to wsconncache if a legacy agent is encountered.
 func NewServerTailnet(
@@ -419,6 +422,10 @@ func (s *ServerTailnet) DialAgentNetConn(ctx context.Context, agentID uuid.UUID,
 	}}, err
 }
 
+func (s *ServerTailnet) ServeHTTPDebug(w http.ResponseWriter, r *http.Request) {
+	s.conn.MagicsockServeHTTPDebug(w, r)
+}
+
 type netConnCloser struct {
 	net.Conn
 	close func()
diff --git a/coderd/workspaceapps/proxy.go b/coderd/workspaceapps/proxy.go
@@ -74,6 +74,8 @@ type AgentProvider interface {
 	// func.
 	AgentConn(ctx context.Context, agentID uuid.UUID) (_ *codersdk.WorkspaceAgentConn, release func(), _ error)
 
+	ServeHTTPDebug(w http.ResponseWriter, r *http.Request)
+
 	Close() error
 }
 
diff --git a/coderd/wsconncache/wsconncache.go b/coderd/wsconncache/wsconncache.go
@@ -16,10 +16,13 @@ import (
 	"golang.org/x/sync/singleflight"
 	"golang.org/x/xerrors"
 
+	"github.com/coder/coder/v2/coderd/workspaceapps"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/site"
 )
 
+var _ workspaceapps.AgentProvider = (*AgentProvider)(nil)
+
 type AgentProvider struct {
 	Cache *Cache
 }
@@ -56,6 +59,8 @@ func (a *AgentProvider) ReverseProxy(targetURL *url.URL, dashboardURL *url.URL,
 	return proxy, release, nil
 }
 
+func (*AgentProvider) ServeHTTPDebug(http.ResponseWriter, *http.Request) {}
+
 func (a *AgentProvider) Close() error {
 	return a.Cache.Close()
 }
diff --git a/docs/api/debug.md b/docs/api/debug.md

Original file line number	Diff line number	Diff line change
`@@ -955,6 +955,7 @@ func New(options Options) API {`
`955`	`955`	`)`
`956`	`956`
`957`	`957`	`r.Get("/coordinator", api.debugCoordinator)`
	`958`	`+ r.Get("/tailnet", api.debugTailnet)`
`958`	`959`	`r.Get("/health", api.debugDeploymentHealth)`
`959`	`960`	`r.Get("/ws", (&healthcheck.WebsocketEchoServer{}).ServeHTTP)`
`960`	`961`	`})`
Original file line number	Diff line number	Diff line change
`@@ -352,7 +352,8 @@ func assertProduce(t *testing.T, comment SwaggerComment) {`
`352`	`352`	`(comment.router == "/workspaceagents/me/startup" && comment.method == "post") \|\|`
`353`	`353`	`(comment.router == "/workspaceagents/me/startup/logs" && comment.method == "patch") \|\|`
`354`	`354`	`(comment.router == "/licenses/{id}" && comment.method == "delete") \|\|`
`355`		`- (comment.router == "/debug/coordinator" && comment.method == "get") {`
	`355`	`+ (comment.router == "/debug/coordinator" && comment.method == "get") \|\|`
	`356`	`+ (comment.router == "/debug/tailnet" && comment.method == "get") {`
`356`	`357`	`return // Exception: HTTP 200 is returned without response entity`
`357`	`358`	`}`
`358`	`359`
Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,8 @@ type AgentProvider interface {`
`74`	`74`	`// func.`
`75`	`75`	`AgentConn(ctx context.Context, agentID uuid.UUID) (_ *codersdk.WorkspaceAgentConn, release func(), _ error)`
`76`	`76`
	`77`	`+ ServeHTTPDebug(w http.ResponseWriter, r *http.Request)`
	`78`	`+`
`77`	`79`	`Close() error`
`78`	`80`	`}`
`79`	`81`
Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,13 @@ import (`
`16`	`16`	`"golang.org/x/sync/singleflight"`
`17`	`17`	`"golang.org/x/xerrors"`
`18`	`18`
	`19`	`+ "github.com/coder/coder/v2/coderd/workspaceapps"`
`19`	`20`	`"github.com/coder/coder/v2/codersdk"`
`20`	`21`	`"github.com/coder/coder/v2/site"`
`21`	`22`	`)`
`22`	`23`
	`24`	`+var _ workspaceapps.AgentProvider = (*AgentProvider)(nil)`
	`25`	`+`
`23`	`26`	`type AgentProvider struct {`
`24`	`27`	`Cache *Cache`
`25`	`28`	`}`
`@@ -56,6 +59,8 @@ func (a AgentProvider) ReverseProxy(targetURL url.URL, dashboardURL *url.URL,`
`56`	`59`	`return proxy, release, nil`
`57`	`60`	`}`
`58`	`61`
	`62`	`+func (AgentProvider) ServeHTTPDebug(http.ResponseWriter, http.Request) {}`
	`63`	`+`
`59`	`64`	`func (a *AgentProvider) Close() error {`
`60`	`65`	`return a.Cache.Close()`
`61`	`66`	`}`