Document agent debug endpoints

The agent has several HTTP endpoints which can be used for debugging. They are defined here: https://github.com/coder/coder/blob/8c0565177e5bc5611130df54cf857f9e6a468027/agent/agent.go#L1799-L1812

We should document that these exist, as well as how to call them. This should naturally also mention the config flag which controls the listening address: https://github.com/coder/coder/blob/e96652ebbcdd7554977594286b32015115c3f5b6/cli/agent.go#L393-L399.

	func (a *agent) HTTPDebug() http.Handler {
	r := chi.NewRouter()

	r.Get("/debug/logs", a.HandleHTTPDebugLogs)
	r.Get("/debug/magicsock", a.HandleHTTPDebugMagicsock)
	r.Get("/debug/magicsock/debug-logging/{state}", a.HandleHTTPMagicsockDebugLoggingState)
	r.Get("/debug/manifest", a.HandleHTTPDebugManifest)
	r.NotFound(func(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusNotFound)
	_, _ = w.Write([]byte("404 not found"))
	})

	return r
	}

	{
	Flag: "debug-address",
	Default: "127.0.0.1:2113",
	Env: "CODER_AGENT_DEBUG_ADDRESS",
	Value: serpent.StringOf(&debugAddress),
	Description: "The bind address to serve a debug HTTP server.",
	},

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Document agent debug endpoints #14362

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Document agent debug endpoints #14362

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.