Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@
"githubRepo": "GitHub Repo",
"restApiReference": "REST API Reference"
},
"download": {
"download": "Download",
"hotkey": "d",
"tooltip": "Press {{hotkey}} to download logs"
},
"duration": "Duration",
"endDate": "End Date",
"error": {
Expand Down
129 changes: 89 additions & 40 deletions airflow-core/src/airflow/ui/src/components/renderStructuredLog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ type RenderStructuredLogProps = {
logLevelFilters?: Array<string>;
logLink: string;
logMessage: string | StructuredLogMessage;
renderingMode?: "jsx" | "text";
showSource?: boolean;
showTimestamp?: boolean;
sourceFilters?: Array<string>;
Expand Down Expand Up @@ -107,17 +108,22 @@ const addAnsiWithLinks = (line: string) => {

const sourceFields = ["logger", "chan", "lineno", "filename", "loc"];

export const renderStructuredLog = ({
const renderStructuredLogImpl = ({
index,
logLevelFilters,
logLink,
logMessage,
renderingMode = "jsx",
showSource = true,
showTimestamp = true,
sourceFilters,
translate,
}: RenderStructuredLogProps) => {
}: RenderStructuredLogProps): JSX.Element | string => {
if (typeof logMessage === "string") {
if (renderingMode === "text") {
return logMessage;
}

return (
<chakra.span key={index} lineHeight={1.5}>
{addAnsiWithLinks(logMessage)}
Expand Down Expand Up @@ -147,36 +153,56 @@ export const renderStructuredLog = ({
}

if (Boolean(timestamp) && showTimestamp) {
elements.push("[", <Time datetime={timestamp} key={0} />, "] ");
if (renderingMode === "text") {
elements.push(`[${timestamp}] `);
} else {
elements.push("[", <Time datetime={timestamp} key={0} />, "] ");
}
}

if (typeof level === "string") {
elements.push(
<Code
colorPalette={level.toUpperCase() in LogLevel ? logLevelColorMapping[level as LogLevel] : undefined}
key={1}
lineHeight={1.5}
minH={0}
px={0}
>
{level.toUpperCase()}
</Code>,
" - ",
);
const formattedLevel = level.toUpperCase();

if (renderingMode === "text") {
elements.push(`${formattedLevel} - `);
} else {
elements.push(
<Code
colorPalette={level.toUpperCase() in LogLevel ? logLevelColorMapping[level as LogLevel] : undefined}
key={1}
lineHeight={1.5}
minH={0}
px={0}
>
{formattedLevel}
</Code>,
" - ",
);
}
}

const { error_detail: errorDetail, ...reStructured } = structured;
let details;

if (errorDetail !== undefined) {
details = (errorDetail as Array<ErrorDetail>).map((error) => {
const errorLines = error.frames.map((frame) => (
<chakra.p key={`frame-${frame.name}-${frame.filename}-${frame.lineno}`}>
{translate("components:logs.file")}{" "}
<chakra.span color="fg.info">{JSON.stringify(frame.filename)}</chakra.span>,{" "}
{translate("components:logs.location", { line: frame.lineno, name: frame.name })}
</chakra.p>
));
const errorLines = error.frames.map((frame) => {
if (renderingMode === "text") {
return ` ${translate("components:logs.file")} ${frame.filename}, ${translate("components:logs.location", { line: frame.lineno, name: frame.name })}\n`;
}

return (
<chakra.p key={`frame-${frame.name}-${frame.filename}-${frame.lineno}`}>
{translate("components:logs.file")}{" "}
<chakra.span color="fg.info">{JSON.stringify(frame.filename)}</chakra.span>,{" "}
{translate("components:logs.location", { line: frame.lineno, name: frame.name })}
</chakra.p>
);
});

if (renderingMode === "text") {
return `${error.exc_type}: ${error.exc_value}\n${(errorLines as Array<string>).join("")}`;
}

return (
<chakra.details key={error.exc_type} ms="20em" open={true}>
Expand All @@ -192,9 +218,13 @@ export const renderStructuredLog = ({
}

elements.push(
<chakra.span className="event" key={2} whiteSpace="pre-wrap">
{addAnsiWithLinks(event)}
</chakra.span>,
renderingMode === "text" ? (
event
) : (
<chakra.span className="event" key={2} whiteSpace="pre-wrap">
{addAnsiWithLinks(event)}
</chakra.span>
),
);

if (Object.hasOwn(reStructured, "filename") && Object.hasOwn(reStructured, "lineno")) {
Expand All @@ -211,27 +241,37 @@ export const renderStructuredLog = ({
}
const val = reStructured[key] as boolean | number | object | string | null;

elements.push(
<React.Fragment key={`space_${key}`}> </React.Fragment>,
<span data-key={key} key={`struct_${key}`}>
<chakra.span color="fg.info">{key === "logger" ? "source" : key}</chakra.span>=
<span data-value>
{
// Let strings, ints, etc through as is, but JSON stringify anything more complex
val instanceof Object ? JSON.stringify(val) : val
}
</span>
</span>,
);
// Let strings, ints, etc through as is, but JSON stringify anything more complex
const stringifiedValue = val instanceof Object ? JSON.stringify(val) : val;

if (renderingMode === "text") {
elements.push(`${key === "logger" ? "source" : key}=${stringifiedValue} `);
} else {
elements.push(
<React.Fragment key={`space_${key}`}> </React.Fragment>,
<span data-key={key} key={`struct_${key}`}>
<chakra.span color="fg.info">{key === "logger" ? "source" : key}</chakra.span>=
<span data-value>{stringifiedValue}</span>
</span>,
);
}
}
}

elements.push(
<chakra.span className="event" key={3} whiteSpace="pre-wrap">
{details}
</chakra.span>,
renderingMode === "text" ? (
details
) : (
<chakra.span className="event" key={3} whiteSpace="pre-wrap">
{details}
</chakra.span>
),
);

if (renderingMode === "text") {
return (elements as Array<string>).join("");
}

return (
<chakra.div display="flex" key={index} lineHeight={1.5}>
<RouterLink
Expand All @@ -257,3 +297,12 @@ export const renderStructuredLog = ({
</chakra.div>
);
};

// Overloads for renderStructuredLog function for stick type safety
type RenderStructuredLogOverloads = {
(props: { renderingMode: "jsx" } & Omit<RenderStructuredLogProps, "renderingMode">): JSX.Element | "";
(props: { renderingMode: "text" } & Omit<RenderStructuredLogProps, "renderingMode">): string;
};

export const renderStructuredLog: RenderStructuredLogOverloads =
renderStructuredLogImpl as unknown as RenderStructuredLogOverloads;
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ export const TaskLogPreview = ({
const { t: translate } = useTranslation("dag");
const [isExpanded, setIsExpanded] = useState(false);

const { data, error, isLoading } = useLogs(
const {
error,
isLoading,
parsedData: data,
} = useLogs(
{
dagId: taskInstance.dag_id,
limit: 100,
Expand Down
68 changes: 50 additions & 18 deletions airflow-core/src/airflow/ui/src/pages/TaskInstance/Logs/Logs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ import { useParams, useSearchParams } from "react-router-dom";
import { useLocalStorage } from "usehooks-ts";

import { useTaskInstanceServiceGetMappedTaskInstance } from "openapi/queries";
import { renderStructuredLog } from "src/components/renderStructuredLog";
import { Dialog } from "src/components/ui";
import { SearchParamsKeys } from "src/constants/searchParams";
import { useConfig } from "src/queries/useConfig";
import { useLogs } from "src/queries/useLogs";
import { parseStreamingLogContent } from "src/utils/logs";

import { ExternalLogLink } from "./ExternalLogLink";
import { TaskLogContent } from "./TaskLogContent";
Expand Down Expand Up @@ -83,6 +85,48 @@ export const Logs = () => {
const [fullscreen, setFullscreen] = useState(false);
const [expanded, setExpanded] = useState(false);

const {
error: logError,
fetchedData,
isLoading: isLoadingLogs,
parsedData,
} = useLogs({
dagId,
expanded,
logLevelFilters,
showSource,
showTimestamp,
sourceFilters,
taskInstance,
tryNumber,
});

const downloadLogs = () => {
const lines = parseStreamingLogContent(fetchedData);
const parsedLines = lines.map((line) =>
renderStructuredLog({
index: 0,
logLevelFilters,
logLink: "",
logMessage: line,
renderingMode: "text",
showSource,
showTimestamp,
sourceFilters,
translate,
}),
);

const logContent = parsedLines.join("\n");
const element = document.createElement("a");

element.href = URL.createObjectURL(new Blob([logContent], { type: "text/plain" }));
element.download = `logs_${taskInstance?.dag_id}_${taskInstance?.dag_run_id}_${taskInstance?.task_id}_${taskInstance?.map_index}_${taskInstance?.try_number}`;
document.body.append(element);
element.click();
element.remove();
};

const toggleWrap = () => setWrap(!wrap);
const toggleTimestamp = () => setShowTimestamp(!showTimestamp);
const toggleSource = () => setShowSource(!showSource);
Expand All @@ -94,37 +138,24 @@ export const Logs = () => {
useHotkeys("e", toggleExpanded);
useHotkeys("t", toggleTimestamp);
useHotkeys("s", toggleSource);
useHotkeys("d", downloadLogs);

const onOpenChange = () => {
setFullscreen(false);
};

const {
data,
error: logError,
isLoading: isLoadingLogs,
} = useLogs({
dagId,
expanded,
logLevelFilters,
showSource,
showTimestamp,
sourceFilters,
taskInstance,
tryNumber,
});

const externalLogName = useConfig("external_log_name") as string;
const showExternalLogRedirect = Boolean(useConfig("show_external_log_redirect"));

return (
<Box display="flex" flexDirection="column" h="100%" p={2}>
<TaskLogHeader
downloadLogs={downloadLogs}
expanded={expanded}
onSelectTryNumber={onSelectTryNumber}
showSource={showSource}
showTimestamp={showTimestamp}
sourceOptions={data.sources}
sourceOptions={parsedData.sources}
taskInstance={taskInstance}
toggleExpanded={toggleExpanded}
toggleFullscreen={toggleFullscreen}
Expand All @@ -149,7 +180,7 @@ export const Logs = () => {
error={error}
isLoading={isLoading || isLoadingLogs}
logError={logError}
parsedLogs={data.parsedLogs ?? []}
parsedLogs={parsedData.parsedLogs ?? []}
wrap={wrap}
/>
<Dialog.Root onOpenChange={onOpenChange} open={fullscreen} scrollBehavior="inside" size="full">
Expand All @@ -158,6 +189,7 @@ export const Logs = () => {
<VStack alignItems="flex-start" gap={2}>
<Heading size="xl">{taskId}</Heading>
<TaskLogHeader
downloadLogs={downloadLogs}
expanded={expanded}
isFullscreen
onSelectTryNumber={onSelectTryNumber}
Expand All @@ -182,7 +214,7 @@ export const Logs = () => {
error={error}
isLoading={isLoading || isLoadingLogs}
logError={logError}
parsedLogs={data.parsedLogs ?? []}
parsedLogs={parsedData.parsedLogs ?? []}
wrap={wrap}
/>
</Dialog.Body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import {
MdOutlineOpenInFull,
MdSettings,
MdWrapText,
MdOutlineFileDownload,
} from "react-icons/md";
import { useSearchParams } from "react-router-dom";

Expand All @@ -45,6 +46,7 @@ import { system } from "src/theme";
import { type LogLevel, logLevelColorMapping, logLevelOptions } from "src/utils/logs";

type Props = {
readonly downloadLogs?: () => void;
readonly expanded?: boolean;
readonly isFullscreen?: boolean;
readonly onSelectTryNumber: (tryNumber: number) => void;
Expand All @@ -62,6 +64,7 @@ type Props = {
};

export const TaskLogHeader = ({
downloadLogs,
expanded,
isFullscreen = false,
onSelectTryNumber,
Expand Down Expand Up @@ -255,6 +258,20 @@ export const TaskLogHeader = ({
</IconButton>
</Tooltip>
)}

<Tooltip closeDelay={100} content={translate("download.tooltip", { hotkey: "d" })} openDelay={100}>
<IconButton
aria-label={translate("download.download")}
bg="bg.panel"
m={0}
onClick={downloadLogs}
px={4}
py={2}
variant="outline"
>
<MdOutlineFileDownload />
</IconButton>
</Tooltip>
</HStack>
</HStack>
</Box>
Expand Down
Loading