shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): document agent api debug endpoints (#14454)

Browse Source 
* 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
This commit is contained in:
Danielle Maywood
2024-08-28 09:47:14 +01:00
committed by GitHub
parent 8c15192433
commit 839918c5e7
6 changed files with 223 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/agent-api/debug.md
+76
View File
@@ -0,0 +1,76 @@
# Debug
## Get debug logs
### Code samples
```shell
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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
## Get debug info for magicsock
### Code samples
```shell
curl $CODER_AGENT_DEBUG_ADDRESS/debug/magicsock
```
`GET /debug/magicsock`
See
[Tailscale's documentation](https://pkg.go.dev/tailscale.com/wgengine/magicsock#Conn.ServeHTTPDebug).
## Toggle debug logging for magicsock
### Code samples
```shell
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](https://pkg.go.dev/tailscale.com/wgengine/magicsock#Conn.SetDebugLoggingEnabled)
for more information.
### Parameters
| Name | In | Type | Required | Description |
| ------- | ---- | ------- | -------- | ------------------- |
| `state` | path | boolean | true | Debug logging state |
### Responses
| Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
## Get debug manifest
### Code samples
```shell
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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.Manifest](./schemas.md#agentsdkmanifest) |