## Summary **Batch A of Phase 3** of the H1 → front-matter migration (`DOCS-484`; parent `DOCS-477`). Adds a front-matter `title` to every navigable docs page whose title can be migrated **mechanically**, with no editorial judgment. This is the content step that Phase 1 (renderers prefer front-matter title, `DOCS-482`) and Phase 2 (tooling + generators front-matter-aware, `DOCS-483`) unblocked. Both are merged; coder.com #964/#974 are merged and live. **Rendered no-op.** The renderers already resolve the page title from the manifest and hide the leading body H1 (Phase 1), so no page changes visually. This just moves the title into front matter where Fumadocs and the migrated tooling can read it. ## What's in this batch Dry-run on `main` (464 navigable pages) splits into: | category | count | this PR | |----------|-------|---------| | already has front-matter title (Reference, from Phase 2 generators) | 196 | skipped (idempotent) | | **mechanical** — leading body H1 equals the manifest label | 138 | ✅ add front-matter `title`, drop the duplicate H1 | | **no body H1** — renders under the manifest label only | 4 | ✅ add front-matter `title` only | | **mismatch** — body H1 differs from the manifest label | 126 | ⏭️ deferred (needs an editorial decision, see below) | 142 files changed, all under `docs/`. ## Deliberately out of scope: the 126 mismatches Pages where the body H1 is richer than the short sidebar label (e.g. label **Modules** / H1 *Contributing modules*, label **Install** / H1 *Installing Coder*) need a canonical-title decision, not a script. A few even look like the body H1 is the redundant one (`install/cli.md` and `install/index.md` both carry the H1 *Installing Coder*). These will land in follow-up batches **by nav section** once the policy is set, so each gets real review. ## Verification AI was the primary author of this PR (see disclosure below); per the [AI Contribution Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING) here is the manual verification. - Every added front-matter block parses as YAML and its `title` round-trips to the manifest label (checked programmatically across all 142 files). - Every removed line is a leading `# H1` that equalled the manifest title; no body prose was reflowed. Front matter is correctly hoisted above pre-existing `<!-- markdownlint-disable -->` comments on the two pages that had them. - `pnpm check-docs` (markdownlint-cli2 + table formatter) passes on the changed set: `Summary: 0 error(s)`. `MD041` stays off (re-enabled in Phase 4); `MD025` is not tripped because the duplicate body H1s are removed. ``` $ pnpm exec markdownlint-cli2 $(git diff --name-only origin/main) Linting: 142 file(s) Summary: 0 error(s) ``` Linear: DOCS-484 > This PR was created with AI assistance (Coder Agents).
4.3 KiB
title
| title |
|---|
| Chat debug logging |
Records a detailed trace of each chat turn for troubleshooting: the normalized request sent to the LLM provider, the full response, token usage, retry attempts, and errors.
Off by default. Three layers control whether it runs for a given chat:
- Deployment override. Setting
CODER_CHAT_DEBUG_LOGGING_ENABLED=true(or--chat-debug-logging-enabledat server start) forces debug logging on for every chat. The runtime admin and user toggles become read-only. - Runtime admin gate. With the deployment override unset, the
Let users record chat debug logs toggle decides whether users can opt
in. Configure it under Admin settings > AI > Coder Agents > Lifecycle, or at
GET/PUT /api/v2/chats/config/debug-logging. - Per-user toggle. Users with the admin gate enabled can turn debug
logging on for their own chats from Agents > Settings > General
under Record debug logs for my chats. The endpoint
PUT /api/v2/chats/config/user-debug-loggingreturns409 Conflictif the deployment override is active and403 Forbiddenif the admin has not enabled user opt-in.
Important
Debug logs may contain sensitive content from prompts, responses, tool calls, and errors. Treat them with the same care as conversation history. Only the chat owner (or a user with read access to the chat) can fetch a chat's debug runs through the API. Administrators do not get blanket access to all users' debug data.
When debug logging is active for a chat, a Debug tab appears in the right panel of the Agents page (alongside Git, Terminal, and Desktop) for that chat's owner. The tab lists recent debug runs and lets you expand a run into its per-step request, response, token usage, retry attempts, errors, and policy metadata.
Export debug logs
You can export the same captured debug data from the UI:
- Navigate to Agents.
- Open a chat with debug logging enabled.
- Open the Debug tab in the right panel.
- Select Export debug logs to download the chat's recent debug runs as JSON, or expand a run and select Export this run to download one run.
The chat-level export includes the full run detail for the runs returned by the debug run list endpoint. The current list endpoint returns up to 100 of the newest runs.
API access
The same data is available through the API:
GET /api/v2/chats/{chat}/debug/runslists the most recent runs for a chat (up to 100, newest first).GET /api/v2/chats/{chat}/debug/runs/{debugRun}returns a single run with all of its steps, including normalized request and response bodies.
Fetch a single run and save it as JSON:
export CODER_URL="https://coder.example.com"
export CODER_SESSION_TOKEN="$(coder login token)"
export CHAT_ID="00000000-0000-0000-0000-000000000000"
export RUN_ID="11111111-1111-1111-1111-111111111111"
curl -fsS \
-H "Coder-Session-Token: $CODER_SESSION_TOKEN" \
"$CODER_URL/api/v2/chats/$CHAT_ID/debug/runs/$RUN_ID" \
| jq . > "coder-agents-debug-run-$RUN_ID.json"
Fetch every run returned by the list endpoint and save a chat-level export.
Using the same CODER_URL, CODER_SESSION_TOKEN, and CHAT_ID variables
from above:
RUN_IDS=$(curl -fsS \
-H "Coder-Session-Token: $CODER_SESSION_TOKEN" \
"$CODER_URL/api/v2/chats/$CHAT_ID/debug/runs" \
| jq -r '.[].id') || {
echo "Failed to list debug runs" >&2
exit 1
}
RUN_EXPORTS=$(mktemp)
trap 'rm -f "$RUN_EXPORTS"' EXIT
for RUN_ID in $RUN_IDS; do
curl -fsS \
-H "Coder-Session-Token: $CODER_SESSION_TOKEN" \
"$CODER_URL/api/v2/chats/$CHAT_ID/debug/runs/$RUN_ID" \
>> "$RUN_EXPORTS" || {
echo "Failed to fetch debug run $RUN_ID" >&2
exit 1
}
echo >> "$RUN_EXPORTS"
done
jq -s \
--arg chat_id "$CHAT_ID" \
--arg exported_at "$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
'{
version: 1,
scope: "chat",
exported_at: $exported_at,
chat_id: $chat_id,
run_count: length,
limited_to_most_recent: 100,
runs: .
}' "$RUN_EXPORTS" > "coder-agents-debug-chat-$CHAT_ID.json"
Debug runs are stored alongside the chat and are removed when the parent conversation is deleted (manually, by retention, or by chat purge). See Data Retention for the conversation retention controls.