synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-06 15:41:45 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
839918c5e792e968d1a23dd08ab28edd14ba1ad5
coder/docs/reference/agent-api/debug.md
Danielle Maywood 839918c5e7 chore(docs): document agent api debug endpoints (#14454) 
* chore(docs): add agent api debug docs

* chore(docs): add sections to agent api readme

* chore(docs): link debug manifest to agentsdk.Manifest schema

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

* chore(docs): link to agent api docs from reference

* chore(docs): fix invalid paths

* chore(docs): use env variable for coder agent debug address
2024-08-28 09:47:14 +01:00

2.1 KiB
Raw Blame History

Debug

Get debug logs

Code samples

curl $CODER_AGENT_DEBUG_ADDRESS/debug/logs

GET /debug/logs

Get the first 10MiB of data from $CODER_AGENT_LOG_DIR/coder-agent.log.

Responses

Status Meaning Description Schema
200 OK OK

Get debug info for magicsock

Code samples

curl $CODER_AGENT_DEBUG_ADDRESS/debug/magicsock

GET /debug/magicsock

See Tailscale's documentation.

Toggle debug logging for magicsock

Code samples

curl $CODER_AGENT_DEBUG_ADDRESS/debug/magicsock/debug-logging/true

GET /debug/magicsock/debug-logging/{state}

Set whether debug logging is enabled. See Tailscale's documentation for more information.

Parameters

Name In Type Required Description
state path boolean true Debug logging state

Responses

Status Meaning Description Schema
200 OK OK

Get debug manifest

Code samples

curl $CODER_AGENT_DEBUG_ADDRESS/debug/manifest

GET /debug/manifest

Get the manifest the agent fetched from coderd upon startup.

Responses

Status Meaning Description Schema
200 OK OK agentsdk.Manifest