mirror of
https://github.com/coder/coder.git
synced 2025-07-06 15:41:45 +00:00
839918c5e7
* 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
77 lines
2.1 KiB
Markdown
77 lines
2.1 KiB
Markdown
# 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) |
|