mirror of
https://github.com/coder/coder.git
synced 2026-09-23 05:41:11 +08:00
Nick Vigilante
c84aa564ba
Normalizes non-standard code-fence language tags across `docs/**` so a strict highlighter (Shiki, used by Fumadocs) won't fail the build on an unrecognized language, and unifies redundant synonym tags onto one canonical form per language. The current renderer (Speed-Highlight) detects the language from the code content, not the fence label, so this drift wasn't visible until now. ## Changes - `hcl` -> `tf` (199 fences, including indented ones nested in numbered/bulleted lists). Shiki ships `hcl` and `terraform` as two distinct grammars (not aliases); every `hcl`-tagged fence in `docs/**` is actually Terraform resource/data/provider syntax, so the more specific `terraform` grammar is correct for all of them. `tf` is Shiki's own alias for that grammar, and it's also what GitHub's own markdown renderer resolves to the same HCL/Terraform highlighting. - `pwsh`/`powershell` -> `ps1`. Both `ps` and `ps1` are registered PowerShell aliases in Shiki, but on GitHub's renderer only `.ps1` is a registered file extension (`.ps` isn't), so `ps1` renders identically to `powershell` there today while bare `ps` would silently lose highlighting. - `env` -> `dotenv` (a dedicated Shiki grammar for `KEY=VALUE` files) - `text`/`output`/`none`/`url` -> `txt`. Same built-in plain-text fallback either way, just shorter. - `Dockerfile` -> `dockerfile` (lowercase) - `bash`/`shell` -> `sh` (732 fences). Shiki and GitHub both alias all three to a single shell grammar; this was already the style guide's stated preference, just not enforced across the existing corpus until now. - `markdown` -> `md` (4 fences). Alias of the same grammar in both Shiki and GitHub. - `jsonc` -> `json` (1 fence). The block has no comments or trailing commas, so it doesn't need the comments-capable grammar. - `ts` -> `tsx` (2 fences, `docs/about/contributing/frontend.md`). Verified the actual content tokenizes identically under both grammars, and a sibling block in the same file already needs `tsx` for real JSX, so unifying to one tag is safe for this file. Documented a caveat: `tsx` mis-tokenizes the legacy angle-bracket type-assertion syntax (`<Type>value`), which is invalid in real `.tsx` files anyway, so use `value as Type` instead. - `yml` -> `yaml` (1 fence) - Updated `docs/.style/style-guide/formatting.md` to document all canonical tags `promql` (2 fences) and `caddyfile` (2 fences) are left as-is. Shiki doesn't bundle a grammar for either, so they need a custom grammar registration when the site adopts Shiki, rather than degrading to `txt`. Tracked as follow-up work under DOCS-118 and [DOCS-544](https://linear.app/codercom/issue/DOCS-544/vendor-a-local-promql-grammar-for-shiki-syntax-highlighting) (promql). Does not touch `offlinedocs/`. Linear: [DOCS-476](https://linear.app/codercom/issue/DOCS-476/normalize-docs-code-fence-languages-de-risk-shikifumadocs) <details> <summary>How the fence tags were verified</summary> Each tag was tested against a real `shiki@latest` highlighter instance (`codeToHtml`/`codeToTokens`) and cross-checked against GitHub's `@wooorm/starry-night` grammar sources (the renderer that actually displays these `.md` files today, in repo browsing and PR diffs), since that's what determines whether brevity is safe before Shiki adoption: ```text FAIL env -- Language `env` is not included in this bundle. FAIL Dockerfile -- Language `Dockerfile` is not included in this bundle. FAIL promql -- Language `promql` is not included in this bundle. FAIL caddyfile -- Language `caddyfile` is not included in this bundle. FAIL pwsh -- Language `pwsh` is not included in this bundle. FAIL output -- Language `output` is not included in this bundle. ``` `hcl` doesn't error in Shiki, since it's a real grammar, but that's exactly the trap: it was silently rendering every fence with the generic HCL grammar instead of the Terraform-specific one. Every `hcl`-tagged fence in `docs/**` was manually checked against `origin/main` and is genuinely Terraform content. For `ts`/`tsx`, tokenizing the actual doc content confirmed identical output under both grammars; a synthetic test with the legacy angle-bracket cast syntax confirmed `tsx` degrades on that specific construct, which the style guide now calls out. The first normalization pass only matched fence tags at column 0 (`^```tag$`), missing tags indented inside numbered/bulleted lists. A follow-up pass caught the remaining occurrences at any indentation level. </details> --- *This PR description and the underlying changes were prepared with Coder Agents assistance.*
528 lines
13 KiB
Markdown
Generated
528 lines
13 KiB
Markdown
Generated
# Debug
|
|
|
|
## Debug Info Wireguard Coordinator
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/debug/coordinator \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/debug/coordinator`
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|--------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Debug Info Deployment Health
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/debug/health \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/debug/health`
|
|
|
|
### Parameters
|
|
|
|
| Name | In | Type | Required | Description |
|
|
|---------|-------|---------|----------|----------------------------|
|
|
| `force` | query | boolean | false | Force a healthcheck to run |
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"access_url": {
|
|
"access_url": "string",
|
|
"dismissed": true,
|
|
"error": "string",
|
|
"healthy": true,
|
|
"healthz_response": "string",
|
|
"reachable": true,
|
|
"severity": "ok",
|
|
"status_code": 0,
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
},
|
|
"coder_version": "string",
|
|
"database": {
|
|
"dismissed": true,
|
|
"error": "string",
|
|
"healthy": true,
|
|
"latency": "string",
|
|
"latency_ms": 0,
|
|
"reachable": true,
|
|
"severity": "ok",
|
|
"threshold_ms": 0,
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
},
|
|
"derp": {
|
|
"dismissed": true,
|
|
"error": "string",
|
|
"healthy": true,
|
|
"netcheck": {
|
|
"captivePortal": "string",
|
|
"globalV4": "string",
|
|
"globalV6": "string",
|
|
"hairPinning": "string",
|
|
"icmpv4": true,
|
|
"ipv4": true,
|
|
"ipv4CanSend": true,
|
|
"ipv6": true,
|
|
"ipv6CanSend": true,
|
|
"mappingVariesByDestIP": "string",
|
|
"oshasIPv6": true,
|
|
"pcp": "string",
|
|
"pmp": "string",
|
|
"preferredDERP": 0,
|
|
"regionLatency": {
|
|
"property1": 0,
|
|
"property2": 0
|
|
},
|
|
"regionV4Latency": {
|
|
"property1": 0,
|
|
"property2": 0
|
|
},
|
|
"regionV6Latency": {
|
|
"property1": 0,
|
|
"property2": 0
|
|
},
|
|
"udp": true,
|
|
"upnP": "string"
|
|
},
|
|
"netcheck_err": "string",
|
|
"netcheck_logs": [
|
|
"string"
|
|
],
|
|
"regions": {
|
|
"property1": {
|
|
"error": "string",
|
|
"healthy": true,
|
|
"node_reports": [
|
|
{
|
|
"can_exchange_messages": true,
|
|
"client_errs": [
|
|
[
|
|
"string"
|
|
]
|
|
],
|
|
"client_logs": [
|
|
[
|
|
"string"
|
|
]
|
|
],
|
|
"error": "string",
|
|
"healthy": true,
|
|
"node": {
|
|
"canPort80": true,
|
|
"certName": "string",
|
|
"derpport": 0,
|
|
"forceHTTP": true,
|
|
"hostName": "string",
|
|
"insecureForTests": true,
|
|
"ipv4": "string",
|
|
"ipv6": "string",
|
|
"name": "string",
|
|
"regionID": 0,
|
|
"stunonly": true,
|
|
"stunport": 0,
|
|
"stuntestIP": "string"
|
|
},
|
|
"node_info": {
|
|
"tokenBucketBytesBurst": 0,
|
|
"tokenBucketBytesPerSecond": 0
|
|
},
|
|
"round_trip_ping": "string",
|
|
"round_trip_ping_ms": 0,
|
|
"severity": "ok",
|
|
"stun": {
|
|
"canSTUN": true,
|
|
"enabled": true,
|
|
"error": "string"
|
|
},
|
|
"uses_websocket": true,
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"region": {
|
|
"avoid": true,
|
|
"embeddedRelay": true,
|
|
"nodes": [
|
|
{
|
|
"canPort80": true,
|
|
"certName": "string",
|
|
"derpport": 0,
|
|
"forceHTTP": true,
|
|
"hostName": "string",
|
|
"insecureForTests": true,
|
|
"ipv4": "string",
|
|
"ipv6": "string",
|
|
"name": "string",
|
|
"regionID": 0,
|
|
"stunonly": true,
|
|
"stunport": 0,
|
|
"stuntestIP": "string"
|
|
}
|
|
],
|
|
"regionCode": "string",
|
|
"regionID": 0,
|
|
"regionName": "string"
|
|
},
|
|
"severity": "ok",
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
},
|
|
"property2": {
|
|
"error": "string",
|
|
"healthy": true,
|
|
"node_reports": [
|
|
{
|
|
"can_exchange_messages": true,
|
|
"client_errs": [
|
|
[
|
|
"string"
|
|
]
|
|
],
|
|
"client_logs": [
|
|
[
|
|
"string"
|
|
]
|
|
],
|
|
"error": "string",
|
|
"healthy": true,
|
|
"node": {
|
|
"canPort80": true,
|
|
"certName": "string",
|
|
"derpport": 0,
|
|
"forceHTTP": true,
|
|
"hostName": "string",
|
|
"insecureForTests": true,
|
|
"ipv4": "string",
|
|
"ipv6": "string",
|
|
"name": "string",
|
|
"regionID": 0,
|
|
"stunonly": true,
|
|
"stunport": 0,
|
|
"stuntestIP": "string"
|
|
},
|
|
"node_info": {
|
|
"tokenBucketBytesBurst": 0,
|
|
"tokenBucketBytesPerSecond": 0
|
|
},
|
|
"round_trip_ping": "string",
|
|
"round_trip_ping_ms": 0,
|
|
"severity": "ok",
|
|
"stun": {
|
|
"canSTUN": true,
|
|
"enabled": true,
|
|
"error": "string"
|
|
},
|
|
"uses_websocket": true,
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"region": {
|
|
"avoid": true,
|
|
"embeddedRelay": true,
|
|
"nodes": [
|
|
{
|
|
"canPort80": true,
|
|
"certName": "string",
|
|
"derpport": 0,
|
|
"forceHTTP": true,
|
|
"hostName": "string",
|
|
"insecureForTests": true,
|
|
"ipv4": "string",
|
|
"ipv6": "string",
|
|
"name": "string",
|
|
"regionID": 0,
|
|
"stunonly": true,
|
|
"stunport": 0,
|
|
"stuntestIP": "string"
|
|
}
|
|
],
|
|
"regionCode": "string",
|
|
"regionID": 0,
|
|
"regionName": "string"
|
|
},
|
|
"severity": "ok",
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"severity": "ok",
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
},
|
|
"healthy": true,
|
|
"provisioner_daemons": {
|
|
"dismissed": true,
|
|
"error": "string",
|
|
"items": [
|
|
{
|
|
"provisioner_daemon": {
|
|
"api_version": "string",
|
|
"created_at": "2019-08-24T14:15:22Z",
|
|
"current_job": {
|
|
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
|
"status": "pending",
|
|
"template_display_name": "string",
|
|
"template_icon": "string",
|
|
"template_name": "string"
|
|
},
|
|
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
|
"key_id": "1e779c8a-6786-4c89-b7c3-a6666f5fd6b5",
|
|
"key_name": "string",
|
|
"last_seen_at": "2019-08-24T14:15:22Z",
|
|
"name": "string",
|
|
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
|
|
"previous_job": {
|
|
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
|
"status": "pending",
|
|
"template_display_name": "string",
|
|
"template_icon": "string",
|
|
"template_name": "string"
|
|
},
|
|
"provisioners": [
|
|
"string"
|
|
],
|
|
"status": "offline",
|
|
"tags": {
|
|
"property1": "string",
|
|
"property2": "string"
|
|
},
|
|
"version": "string"
|
|
},
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"severity": "ok",
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
},
|
|
"severity": "ok",
|
|
"time": "2019-08-24T14:15:22Z",
|
|
"websocket": {
|
|
"body": "string",
|
|
"code": 0,
|
|
"dismissed": true,
|
|
"error": "string",
|
|
"healthy": true,
|
|
"severity": "ok",
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
]
|
|
},
|
|
"workspace_proxy": {
|
|
"dismissed": true,
|
|
"error": "string",
|
|
"healthy": true,
|
|
"severity": "ok",
|
|
"warnings": [
|
|
{
|
|
"code": "EUNKNOWN",
|
|
"message": "string"
|
|
}
|
|
],
|
|
"workspace_proxies": {
|
|
"regions": [
|
|
{
|
|
"created_at": "2019-08-24T14:15:22Z",
|
|
"deleted": true,
|
|
"derp_enabled": true,
|
|
"derp_only": true,
|
|
"display_name": "string",
|
|
"healthy": true,
|
|
"icon_url": "string",
|
|
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
|
"name": "string",
|
|
"path_app_url": "string",
|
|
"status": {
|
|
"checked_at": "2019-08-24T14:15:22Z",
|
|
"report": {
|
|
"errors": [
|
|
"string"
|
|
],
|
|
"warnings": [
|
|
"string"
|
|
]
|
|
},
|
|
"status": "ok"
|
|
},
|
|
"updated_at": "2019-08-24T14:15:22Z",
|
|
"version": "string",
|
|
"wildcard_hostname": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthcheckReport](schemas.md#healthsdkhealthcheckreport) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Get health settings
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/debug/health/settings \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/debug/health/settings`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"dismissed_healthchecks": [
|
|
"DERP"
|
|
]
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthSettings](schemas.md#healthsdkhealthsettings) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Update health settings
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X PUT http://coder-server:8080/api/v2/debug/health/settings \
|
|
-H 'Content-Type: application/json' \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`PUT /api/v2/debug/health/settings`
|
|
|
|
> Body parameter
|
|
|
|
```json
|
|
{
|
|
"dismissed_healthchecks": [
|
|
"DERP"
|
|
]
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Name | In | Type | Required | Description |
|
|
|--------|------|----------------------------------------------------------------------------|----------|------------------------|
|
|
| `body` | body | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) | true | Update health settings |
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"dismissed_healthchecks": [
|
|
"DERP"
|
|
]
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Debug Info Tailnet
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/debug/tailnet \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/debug/tailnet`
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|--------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|