2026-08-27 12:34:13 -04:00
|
|
|
---
|
|
|
|
|
title: Debug
|
|
|
|
|
---
|
2024-08-28 09:47:14 +01:00
|
|
|
|
|
|
|
|
## Get debug logs
|
|
|
|
|
|
|
|
|
|
### Code samples
|
|
|
|
|
|
2026-07-15 14:07:09 -04:00
|
|
|
```sh
|
2024-08-28 09:47:14 +01:00
|
|
|
curl $CODER_AGENT_DEBUG_ADDRESS/debug/logs
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
`GET /debug/logs`
|
|
|
|
|
|
2026-09-28 12:29:40 -04:00
|
|
|
Get the first 10 MiB of data from `$CODER_AGENT_LOG_DIR/coder-agent.log`.
|
2024-08-28 09:47:14 +01:00
|
|
|
|
|
|
|
|
### Responses
|
|
|
|
|
|
|
|
|
|
| Status | Meaning | Description | Schema |
|
2025-01-03 18:12:59 +05:00
|
|
|
|--------|---------------------------------------------------------|-------------|--------|
|
2024-08-28 09:47:14 +01:00
|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
|
|
|
|
|
|
|
|
|
|
## Get debug info for magicsock
|
|
|
|
|
|
|
|
|
|
### Code samples
|
|
|
|
|
|
2026-07-15 14:07:09 -04:00
|
|
|
```sh
|
2024-08-28 09:47:14 +01:00
|
|
|
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
|
|
|
|
|
|
2026-07-15 14:07:09 -04:00
|
|
|
```sh
|
2024-08-28 09:47:14 +01:00
|
|
|
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 |
|
2025-01-03 18:12:59 +05:00
|
|
|
|---------|------|---------|----------|---------------------|
|
2024-08-28 09:47:14 +01:00
|
|
|
| `state` | path | boolean | true | Debug logging state |
|
|
|
|
|
|
|
|
|
|
### Responses
|
|
|
|
|
|
|
|
|
|
| Status | Meaning | Description | Schema |
|
2025-01-03 18:12:59 +05:00
|
|
|
|--------|---------------------------------------------------------|-------------|--------|
|
2024-08-28 09:47:14 +01:00
|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
|
|
|
|
|
|
|
|
|
|
## Get debug manifest
|
|
|
|
|
|
|
|
|
|
### Code samples
|
|
|
|
|
|
2026-07-15 14:07:09 -04:00
|
|
|
```sh
|
2024-08-28 09:47:14 +01:00
|
|
|
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 |
|
2025-01-03 18:12:59 +05:00
|
|
|
|--------|---------------------------------------------------------|-------------|----------------------------------------------------|
|
2024-08-28 09:47:14 +01:00
|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.Manifest](./schemas.md#agentsdkmanifest) |
|