Document format parameter (json,text) for logs endpoints
@johnstcn 已经在做这个了。
开始于 2026年2月3日。
评估
这个 Issue 还没有评估数据。
描述
Documentation Check
Previous Feedback
Not yet addressed - The suggestion from the previous doc-check review (2026-01-29) has not been implemented.
Updates Needed
-
docs/admin/monitoring/logs.md- Add section explaining the new?format=textquery parameter for viewing raw logs- Document that users can append
?format=textto log API endpoints to get plain text output with RFC3339 timestamps - Explain that this format is useful for sharing logs externally, viewing in browser, or using with curl/wget
- Note the limitation: cannot be combined with
follow=true(streaming) - List the four endpoints that support this parameter:
/api/v2/workspaceagents/{id}/logs?format=text/api/v2/workspacebuilds/{id}/logs?format=text/api/v2/templateversions/{id}/logs?format=text/api/v2/templateversions/{id}/dry-run/{jobID}/logs?format=text
- Mention that "View raw logs" links are available in the UI (workspace build page, template editor, template version page)
- Include example:
curl https://coder.example.com/api/v2/workspacebuilds/{build-id}/logs?format=text
- Document that users can append
Rationale
The PR is fully implemented with UI links and backend functionality, but user-facing documentation explaining the feature is still missing. Users seeing "View raw logs" links in the UI will want to understand:
- What the raw format provides (RFC3339 timestamps + plain text)
- When to use it (sharing logs, external tools, debugging)
- How to use it programmatically (API endpoints with
?format=text) - What limitations exist (no streaming support)
The auto-generated API reference docs document the parameter but don't explain the use case or workflow.
Automated review via Coder Tasks
Originally posted by @coder-tasks[bot] in https://github.com/coder/coder/issues/21727#issuecomment-3840116744
- 主要语言
- 没有语言数据
- 星标
- 3
- 派生
- 0
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
coder/internal 的其他 Issue
-
flake
难度 2/5 1-3 小时 新手友好度 72/100
-
chore: cleanup http transport debt可能已有人在做 @sreya 于 19 天前认领。 未关闭
-
难度 4/5 3-5 天 新手友好度 45/100
-
flake: TestPubsubCluster/ClusterAuthRequired可能重新可做 @sreya 于 70 天前认领，目前没有进行中的 PR。 未关闭flake
-
flake: TestSnapshotChanged_MultipleConfigFiles (multiple variants)可能重新可做 @Shelnutt2 于 89 天前认领，目前没有进行中的 PR。 未关闭