Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Document format parameter (json,text) for logs endpoints

Đang mở
  • Có gì không ổn?
#1,327 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

@johnstcn đang làm issue này rồi.

Từ ngày 3/2/2026.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
3
Fork
0
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của coder/internal

Tất cả issue của coder/internal

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.