Skip to content

[Feature] Add "View Logs" action to RayCluster and implement Log Viewer UI #4446

@CheyuWu

Description

@CheyuWu

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

  1. Entry Point: - Add a "View Logs" option within the Action Button menu (or Action group) of each RayCluster in the cluster list/detail view.

  2. Interaction: - Clicking "View Logs" will open a Modal or a Side Drawer containing the Log Viewer.

  3. Log Viewer Component:

    • A dedicated terminal-like interface built with @mui/joy.
    • Support for auto-scrolling and basic keyword highlighting (ERROR/WARN).
  4. Add Download button in the log view to download the logs file

Technical Details

  • API Endpoint: /api/v0/logs/file
  • Data Format: Plain text (verified here)
  • Component Stack: @mui/joy (Sheet, Typography, Stack, etc)

Proposed Implementation Path

  1. New Component: Create dashboard/src/components/LogViewer.tsx using Joy UI Sheet and Typography to render plain-text logs with auto scroll support.
  2. API Integration: Implement a new data-fetching hook in dashboard/src/hooks/api/useGetLogs.ts to interface with the /api/v0/logs/file endpoint.
  3. UI Entry Point: Add a "View Logs" button to the Actions column in dashboard/src/app/history/raycluster/page.tsx .
  4. User Experience: Clicking the button will trigger a Modal to display the log stream for the specific node.

View Logs button can be an Icon

Image ### Use case

No response

Related issues

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions