Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Document format parameter (json,text) for logs endpoints

Abierto
#1,327 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@johnstcn ya está trabajando en esto.

Desde el 3/2/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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

Lenguaje dominante
Sin datos de lenguaje
Estrellas
3
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de coder/internal

Todos los issues de coder/internal

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.