[Dashboard] Add task detail page with logs (#35328)

Add task detail page with logs Update actor logs to use state-api actor_id filter instead of filename to fetch logs Hide log tabs if there is only 1 tab available. Update the driver logs in the jobs page to show explanation why logs are not available.
ray-project · May 16, 2023 · 35cb004 · 35cb004
1 parent 496024d
commit 35cb004
Show file tree

Hide file tree

Showing 26 changed files with 796 additions and 287 deletions.
diff --git a/dashboard/client/src/App.tsx b/dashboard/client/src/App.tsx
@@ -4,7 +4,7 @@ import dayjs from "dayjs";
 import duration from "dayjs/plugin/duration";
 import React, { Suspense, useEffect, useState } from "react";
 import { HashRouter, Navigate, Route, Routes } from "react-router-dom";
-import ActorDetailPage from "./pages/actor/ActorDetail";
+import ActorDetailPage, { ActorDetailLayout } from "./pages/actor/ActorDetail";
 import { ActorLayout } from "./pages/actor/ActorLayout";
 import Loading from "./pages/exception/Loading";
 import JobList, { JobsLayout } from "./pages/job";
@@ -33,6 +33,7 @@ import { ServeApplicationsListPage } from "./pages/serve/ServeApplicationsListPa
 import { ServeLayout } from "./pages/serve/ServeLayout";
 import { ServeReplicaDetailPage } from "./pages/serve/ServeReplicaDetailPage";
 import { ServeHttpProxyDetailPage } from "./pages/serve/ServeSystemActorDetailPage";
+import { TaskPage } from "./pages/task/TaskPage";
 import { getNodeList } from "./service/node";
 import { lightTheme } from "./theme";
 
@@ -201,16 +202,23 @@ const App = () => {
                     <Route
                       element={
                         <JobDetailActorDetailWrapper>
-                          <ActorDetailPage />
+                          <ActorDetailLayout />
                         </JobDetailActorDetailWrapper>
                       }
                       path="actors/:actorId"
-                    />
+                    >
+                      <Route element={<ActorDetailPage />} path="" />
+                      <Route element={<TaskPage />} path="tasks/:taskId" />
+                    </Route>
+                    <Route element={<TaskPage />} path="tasks/:taskId" />
                   </Route>
                 </Route>
                 <Route element={<ActorLayout />} path="actors">
                   <Route element={<Actors />} path="" />
-                  <Route element={<ActorDetailPage />} path=":actorId" />
+                  <Route element={<ActorDetailLayout />} path=":actorId">
+                    <Route element={<ActorDetailPage />} path="" />
+                    <Route element={<TaskPage />} path="tasks/:taskId" />
+                  </Route>
                 </Route>
                 <Route element={<Metrics />} path="metrics" />
                 <Route element={<ServeLayout />} path="serve">

diff --git a/dashboard/client/src/common/MultiTabLogViewer.tsx b/dashboard/client/src/common/MultiTabLogViewer.tsx
@@ -25,9 +25,7 @@ const useStyles = makeStyles((theme) =>
 
 export type MultiTabLogViewerTabDetails = {
   title: string;
-  nodeId: string | null;
-  filename?: string;
-};
+} & LogViewerData;
 
 export type MultiTabLogViewerProps = {
   tabs: MultiTabLogViewerTabDetails[];
@@ -45,6 +43,10 @@ export const MultiTabLogViewer = ({
 
   const currentTab = tabs.find((tab) => tab.title === value);
 
+  if (tabs.length === 0) {
+    return <Typography>No logs to display.</Typography>;
+  }
+
   return (
     <div className={className}>
       <Box
@@ -59,52 +61,56 @@ export const MultiTabLogViewer = ({
           alignItems="stretch"
           flexGrow={1}
         >
-          <Tabs
-            className={classes.tabs}
-            value={value}
-            onChange={(_, newValue) => {
-              setValue(newValue);
-            }}
-            indicatorColor="primary"
-          >
-            {tabs.map(({ title }) => (
-              <Tab key={title} label={title} value={title} />
-            ))}
-            {otherLogsLink && (
-              <Tab
-                label={
-                  <Box display="flex" alignItems="center">
-                    Other logs &nbsp; <RiExternalLinkLine size={20} />
-                  </Box>
-                }
-                onClick={(event) => {
-                  // Prevent the tab from changing
-                  setValue(value);
-                }}
-                component={Link}
-                to={otherLogsLink}
-                target="_blank"
-                rel="noopener noreferrer"
-              />
-            )}
-          </Tabs>
+          {(tabs.length > 1 || otherLogsLink) && (
+            <Tabs
+              className={classes.tabs}
+              value={value}
+              onChange={(_, newValue) => {
+                setValue(newValue);
+              }}
+              indicatorColor="primary"
+            >
+              {tabs.map(({ title }) => (
+                <Tab key={title} label={title} value={title} />
+              ))}
+              {otherLogsLink && (
+                <Tab
+                  label={
+                    <Box display="flex" alignItems="center">
+                      Other logs &nbsp; <RiExternalLinkLine size={20} />
+                    </Box>
+                  }
+                  onClick={(event) => {
+                    // Prevent the tab from changing
+                    setValue(value);
+                  }}
+                  component={Link}
+                  to={otherLogsLink}
+                  target="_blank"
+                  rel="noopener noreferrer"
+                />
+              )}
+            </Tabs>
+          )}
 
           {!currentTab ? (
             <Typography color="error">Please select a tab.</Typography>
           ) : (
-            tabs.map(({ title, nodeId, filename }) => (
-              <HideableBlock
-                key={title}
-                visible={title === currentTab?.title}
-                keepRendered
-              >
-                <StateApiLogViewer
-                  nodeId={nodeId}
-                  filename={filename}
-                  height={expanded ? 800 : 300}
-                />
-              </HideableBlock>
-            ))
+            tabs.map((tab) => {
+              const { title, ...data } = tab;
+              return (
+                <HideableBlock
+                  key={title}
+                  visible={title === currentTab?.title}
+                  keepRendered
+                >
+                  <StateApiLogViewer
+                    data={data}
+                    height={expanded ? 800 : 300}
+                  />
+                </HideableBlock>
+              );
+            })
           )}
         </Box>
         <IconButton
@@ -119,23 +125,114 @@ export const MultiTabLogViewer = ({
   );
 };
 
-export type StateApiLogViewerProps = {
-  nodeId?: string | null;
+type TextData = {
+  contents: string;
+};
+type FileData = {
+  nodeId: string | null;
   filename?: string;
+};
+type ActorData = {
+  actorId: string | null;
+  suffix: "out" | "err";
+};
+type TaskData = {
+  taskId: string | null;
+  suffix: "out" | "err";
+};
+
+type LogViewerData = TextData | FileData | ActorData | TaskData;
+
+const isLogViewerDataText = (data: LogViewerData): data is TextData =>
+  "contents" in data;
+
+const isLogViewerDataActor = (data: LogViewerData): data is ActorData =>
+  "actorId" in data;
+
+const isLogViewerDataTask = (data: LogViewerData): data is TaskData =>
+  "taskId" in data;
+
+export type StateApiLogViewerProps = {
   height?: number;
+  data: LogViewerData;
 };
 
 export const StateApiLogViewer = ({
+  height = 300,
+  data,
+}: StateApiLogViewerProps) => {
+  if (isLogViewerDataText(data)) {
+    return <TextLogViewer height={height} contents={data.contents} />;
+  } else if (isLogViewerDataActor(data)) {
+    return <ActorLogViewer height={height} {...data} />;
+  } else if (isLogViewerDataTask(data)) {
+    return <TaskLogViewer height={height} {...data} />;
+  } else {
+    return <FileLogViewer height={height} {...data} />;
+  }
+};
+
+const TextLogViewer = ({
+  height = 300,
+  contents,
+}: {
+  height: number;
+  contents: string;
+}) => {
+  return <LogViewer log={contents} height={height} />;
+};
+
+const FileLogViewer = ({
+  height = 300,
   nodeId,
   filename,
+}: {
+  height: number;
+} & FileData) => {
+  const apiData = useStateApiLogs({ nodeId, filename }, filename);
+  return <ApiLogViewer apiData={apiData} height={height} />;
+};
+
+const ActorLogViewer = ({
   height = 300,
-}: StateApiLogViewerProps) => {
-  const { downloadUrl, log, path, refresh } = useStateApiLogs(nodeId, filename);
+  actorId,
+  suffix,
+}: {
+  height: number;
+} & ActorData) => {
+  const apiData = useStateApiLogs(
+    { actorId, suffix },
+    `actor-log-${actorId}.${suffix}`,
+  );
+  return <ApiLogViewer apiData={apiData} height={height} />;
+};
+
+const TaskLogViewer = ({
+  height = 300,
+  taskId,
+  suffix,
+}: {
+  height: number;
+} & TaskData) => {
+  const apiData = useStateApiLogs(
+    { taskId, suffix },
+    `task-log-${taskId}.${suffix}`,
+  );
+  return <ApiLogViewer apiData={apiData} height={height} />;
+};
+
+const ApiLogViewer = ({
+  apiData: { downloadUrl, log, path, refresh },
+  height = 300,
+}: {
+  apiData: ReturnType<typeof useStateApiLogs>;
+  height: number;
+}) => {
   return typeof log === "string" ? (
     <LogViewer
       log={log}
       path={path}
-      downloadUrl={downloadUrl}
+      downloadUrl={downloadUrl !== null ? downloadUrl : undefined}
       height={height}
       onRefreshClick={() => {
         refresh();

diff --git a/dashboard/client/src/components/AutoscalerStatusCards.tsx b/dashboard/client/src/components/AutoscalerStatusCards.tsx
@@ -31,7 +31,7 @@ const formatClusterStatus = (title: string, cluster_status: string) => {
   return (
     <div>
       <Box marginBottom={2}>
-        <Typography variant="h6">{title}</Typography>
+        <Typography variant="h3">{title}</Typography>
       </Box>
       {cluster_status_rows.map((i, key) => {
         // Format the output.
@@ -64,9 +64,6 @@ export const NodeStatusCard = ({ cluster_status }: StatusCardProps) => {
         overflow: "hidden",
         overflowY: "scroll",
       }}
-      sx={{ borderRadius: "16px" }}
-      marginLeft={1}
-      marginRight={1}
     >
       {cluster_status?.data
         ? formatNodeStatus(cluster_status?.data.clusterStatus)
@@ -82,9 +79,6 @@ export const ResourceStatusCard = ({ cluster_status }: StatusCardProps) => {
         overflow: "hidden",
         overflowY: "scroll",
       }}
-      sx={{ border: 1, borderRadius: "1", borderColor: "primary.main" }}
-      marginLeft={1}
-      marginRight={1}
     >
       {cluster_status?.data
         ? formatResourcesStatus(cluster_status?.data.clusterStatus)