chore(docs): add high level overview of agent api debug docs

DanielleMaywood · DanielleMaywood · commit 02643881a6ec · 2024-08-27T14:29:12.000Z
diff --git a/agent/agent.go b/agent/agent.go
@@ -1787,7 +1787,7 @@ func (a *agent) HandleHTTPDebugLogs(w http.ResponseWriter, r *http.Request) {
 	}
 	defer f.Close()
 
-	// Limit to 10MB.
+	// Limit to 10MiB.
 	w.WriteHeader(http.StatusOK)
 	_, err = io.Copy(w, io.LimitReader(f, 10*1024*1024))
 	if err != nil && !errors.Is(err, io.EOF) {
diff --git a/docs/reference/agent-api/debug.md b/docs/reference/agent-api/debug.md
@@ -10,6 +10,8 @@ curl http://127.0.0.1:2113/debug/logs
 
 `GET /debug/logs`
 
+Get the first 10MiB of data from `$CODER_AGENT_LOG_DIR/coder-agent.log`.
+
 ### Responses
 
 | Status | Meaning                                                 | Description | Schema |
@@ -26,11 +28,8 @@ curl http://127.0.0.1:2113/debug/magicsock
 
 `GET /debug/magicsock`
 
-### Responses
-
 See
-[Tailscale's documentation](https://pkg.go.dev/tailscale.com/wgengine/magicsock#Conn.ServeHTTPDebug)
-for response format.
+[Tailscale's documentation](https://pkg.go.dev/tailscale.com/wgengine/magicsock#Conn.ServeHTTPDebug).
 
 ## Toggle debug logging for magicsock
 
@@ -42,6 +41,10 @@ curl http://127.0.0.1:2113/debug/magicsock/debug-logging/true
 
 `GET /debug/magicsock/debug-logging/{state}`
 
+Set whether debug logging is enabled. See
+[Tailscale's documentation](https://pkg.go.dev/tailscale.com/wgengine/magicsock#Conn.SetDebugLoggingEnabled)
+for more information.
+
 ### Parameters
 
 | Name    | In   | Type    | Required | Description         |
@@ -64,6 +67,8 @@ curl http://127.0.0.1:2113/debug/manifest
 
 `GET /debug/manifest`
 
+Get the manifest the agent fetched from `coderd` upon startup.
+
 ### Responses
 
 | Status | Meaning                                                 | Description | Schema                                          |

Original file line number	Diff line number	Diff line change
`@@ -1787,7 +1787,7 @@ func (a agent) HandleHTTPDebugLogs(w http.ResponseWriter, r http.Request) {`
`1787`	`1787`	`}`
`1788`	`1788`	`defer f.Close()`
`1789`	`1789`
`1790`		`- // Limit to 10MB.`
	`1790`	`+ // Limit to 10MiB.`
`1791`	`1791`	`w.WriteHeader(http.StatusOK)`
`1792`	`1792`	`_, err = io.Copy(w, io.LimitReader(f, 1010241024))`
`1793`	`1793`	`if err != nil && !errors.Is(err, io.EOF) {`