Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Document format parameter (json,text) for logs endpoints

オープン
#1,327 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@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=text query parameter for viewing raw logs
    • Document that users can append ?format=text to 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
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 はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

coder/internal のほかの issue

coder/internal の issue をすべて見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。