Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document format parameter (json,text) for logs endpoints

Aperta
#1,327 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@johnstcn ci sta già lavorando.

Dal 3/2/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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

Lingua principale
Nessun dato sulla lingua
Stelle
3
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di coder/internal

Tutte le issue di coder/internal

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.