Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Show pipeline run pod logs per selected node #1652

Closed
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
23 changes: 23 additions & 0 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"@patternfly/react-code-editor": "^4.82.115",
"@patternfly/react-core": "4.276.6",
"@patternfly/react-icons": "4.93.6",
"@patternfly/react-log-viewer": "^4.87.100",
"@patternfly/react-styles": "4.92.6",
"@patternfly/react-table": "4.112.39",
"@patternfly/react-topology": "^4.91.27",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
import React from 'react';
import { LogViewer } from '@patternfly/react-log-viewer';
import {
Badge,
Button,
Tooltip,
Toolbar,
ToolbarContent,
ToolbarGroup,
ToolbarItem,
ToolbarToggleGroup,
Alert,
AlertActionCloseButton,

Check failure on line 13 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'AlertActionCloseButton' is defined but never used

Check failure on line 13 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'AlertActionCloseButton' is defined but never used

Check failure on line 13 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'AlertActionCloseButton' is defined but never used
AlertActionLink,

Check failure on line 14 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'AlertActionLink' is defined but never used

Check failure on line 14 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'AlertActionLink' is defined but never used

Check failure on line 14 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'AlertActionLink' is defined but never used
TextListItem,
TextListItemVariants,
TextContent,
TextList,

Check failure on line 18 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'TextList' is defined but never used

Check failure on line 18 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'TextList' is defined but never used

Check failure on line 18 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'TextList' is defined but never used
} from '@patternfly/react-core';
import {
Select as SelectDeprecated,
SelectOption as SelectOptionDeprecated,
} from '@patternfly/react-core';
import { PipelineRunTaskDetails } from '~/concepts/pipelines/content/types';

Check failure on line 24 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

`~/concepts/pipelines/content/types` import should occur after import of `@patternfly/react-icons/dist/esm/icons/download-icon`

Check failure on line 24 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

`~/concepts/pipelines/content/types` import should occur after import of `@patternfly/react-icons/dist/esm/icons/download-icon`

Check failure on line 24 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

`~/concepts/pipelines/content/types` import should occur after import of `@patternfly/react-icons/dist/esm/icons/download-icon`
import OutlinedPlayCircleIcon from '@patternfly/react-icons/dist/esm/icons/outlined-play-circle-icon';
import PauseIcon from '@patternfly/react-icons/dist/esm/icons/pause-icon';
import PlayIcon from '@patternfly/react-icons/dist/esm/icons/play-icon';
import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon';
import DownloadIcon from '@patternfly/react-icons/dist/esm/icons/download-icon';

Check failure on line 29 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'DownloadIcon' is defined but never used

Check failure on line 29 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'DownloadIcon' is defined but never used

Check failure on line 29 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'DownloadIcon' is defined but never used

type LogsTabProps = {
task: PipelineRunTaskDetails;
};
const LogsTab: React.FC<LogsTabProps> = ({ task }) => {

Check failure on line 34 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'task' is defined but never used

Check failure on line 34 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'task' is defined but never used

Check failure on line 34 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'task' is defined but never used
const dataSources = {
'container-1': { type: 'C', id: 'data1' },
'container-2': { type: 'D', id: 'data2' },
'container-3': { type: 'E', id: 'data3' },
};
const [isPaused, setIsPaused] = React.useState(false);
const [isFullScreen, setIsFullScreen] = React.useState(false);

Check failure on line 41 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'setIsFullScreen' is assigned a value but never used

Check failure on line 41 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'setIsFullScreen' is assigned a value but never used

Check failure on line 41 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'setIsFullScreen' is assigned a value but never used
const [itemCount, setItemCount] = React.useState(1);

Check failure on line 42 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'itemCount' is assigned a value but never used

Check failure on line 42 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'itemCount' is assigned a value but never used

Check failure on line 42 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'itemCount' is assigned a value but never used
const [currentItemCount, setCurrentItemCount] = React.useState(0);
const [renderData, setRenderData] = React.useState('');

Check failure on line 44 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'renderData' is assigned a value but never used

Check failure on line 44 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'renderData' is assigned a value but never used

Check failure on line 44 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'renderData' is assigned a value but never used
const [selectedDataSource, setSelectedDataSource] = React.useState('container-1');

Check failure on line 45 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'setSelectedDataSource' is assigned a value but never used

Check failure on line 45 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'setSelectedDataSource' is assigned a value but never used

Check failure on line 45 in frontend/src/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab.tsx

View workflow job for this annotation

GitHub Actions / Tests (18.x)

'setSelectedDataSource' is assigned a value but never used
const [selectDataSourceOpen, setSelectDataSourceOpen] = React.useState(false);
const [timer, setTimer] = React.useState(500);
const [selectedData, setSelectedData] = React
.useState
// data[dataSources[selectedDataSource].id].split('\n'),
();
const [buffer, setBuffer] = React.useState([]);
const [linesBehind, setLinesBehind] = React.useState(0);
const logViewerRef = React.useRef();

React.useEffect(() => {
setTimer(
window.setInterval(() => {
setItemCount((itemCount) => itemCount + 1);
}, 500),
);
return () => {
window.clearInterval(timer);
};
}, []);

// React.useEffect(() => {
// if (itemCount > selectedData.length) {
// window.clearInterval(timer);
// } else {
// setBuffer(selectedData.slice(0, itemCount));
// }
// }, [itemCount]);

React.useEffect(() => {
if (!isPaused && buffer.length > 0) {
setCurrentItemCount(buffer.length);
setRenderData(buffer.join('\n'));
// if (logViewerRef && logViewerRef.current) {
// logViewerRef.current.scrollToBottom();
// }
} else if (buffer.length !== currentItemCount) {
setLinesBehind(buffer.length - currentItemCount);
} else {
setLinesBehind(0);
}
}, [isPaused, buffer]);

const onDownloadClick = () => {
const element = document.createElement('a');
// const dataToDownload = [data[dataSources[selectedDataSource].id]];
// const file = new Blob(dataToDownload, { type: 'text/plain' });
// element.href = URL.createObjectURL(file);
element.download = `${selectedDataSource}.txt`;
document.body.appendChild(element);
element.click();
document.body.removeChild(element);
};

const onScroll = ({ scrollOffsetToBottom, _scrollDirection, scrollUpdateWasRequested }) => {
if (!scrollUpdateWasRequested) {
if (scrollOffsetToBottom > 0) {
setIsPaused(true);
} else {
setIsPaused(false);
}
}
_scrollDirection = 'forward';
};

const selectDataSourceMenu = Object.entries(dataSources).map(([value, { type }]) => (
<SelectOptionDeprecated
key={value}
value={value}
isSelected={selectedDataSource === value}
isChecked={selectedDataSource === value}
>
<Badge key={value}>{type}</Badge>
{` ${value}`}
</SelectOptionDeprecated>
));

const selectDataSourcePlaceholder = (
<React.Fragment>
<Badge>{dataSources[selectedDataSource].type}</Badge>
{` ${selectedDataSource}`}
</React.Fragment>
);

const ControlButton = () => (
<Button
variant={isPaused ? 'plain' : 'link'}
onClick={() => {
setIsPaused(!isPaused);
}}
>
{isPaused ? <PlayIcon /> : <PauseIcon />}
{isPaused ? ` Resume refreshing` : ` Pause refreshing`}
</Button>
);

const leftAlignedToolbarGroup = (
<React.Fragment>
<ToolbarToggleGroup toggleIcon={<EllipsisVIcon />} breakpoint="md">
<ToolbarItem>
<TextContent>
<TextListItem component={TextListItemVariants.dt}>Container</TextListItem>
</TextContent>
</ToolbarItem>
<ToolbarItem variant="search-filter">
<SelectDeprecated
onToggle={(_event, isOpen) => setSelectDataSourceOpen(_event)}
onSelect={(event, selection) => {
setSelectDataSourceOpen(false);
// setSelectedDataSource(selection);
// setSelectedData(data[dataSources[selection].id].split('\n'));
setLinesBehind(0);
setBuffer([]);
setItemCount(1);
setCurrentItemCount(0);
}}
selections={selectedDataSource}
isOpen={selectDataSourceOpen}
placeholderText={selectDataSourcePlaceholder}
>
{selectDataSourceMenu}
</SelectDeprecated>
</ToolbarItem>
</ToolbarToggleGroup>
<ToolbarItem>
<ControlButton />
</ToolbarItem>
</React.Fragment>
);

const rightAlignedToolbarGroup = (
<React.Fragment>
<ToolbarGroup variant="icon-button-group">
<ToolbarItem>
<Tooltip position="top" content={<div>Download</div>}>
<Button onClick={onDownloadClick} variant="plain" aria-label="Download current logs">
Download
</Button>
</Tooltip>
</ToolbarItem>
</ToolbarGroup>
</React.Fragment>
);

const FooterButton = () => {
const handleClick = (_e) => {
setIsPaused(false);
};
return (
<Button onClick={handleClick} isBlock>
<OutlinedPlayCircleIcon />
resume {linesBehind === 0 ? null : `and show ${linesBehind} lines`}
</Button>
);
};
return (
<>
<Alert
isExpandable
isInline
variant="warning"
title="The log window displays partial content"
>
<p>
The log refreshes every 3 seconds and displays the latest 500 lines. Exceptionally long
lines are abridged. To view the full log for this task, you can download all container
logs associated with it.
</p>
</Alert>
<LogViewer
data={'data'}
// id="log-tabs-toolbar"
scrollToRow={currentItemCount}
innerRef={logViewerRef}
height={isFullScreen ? '100%' : 600}
width={isFullScreen ? '100%' : 500}
toolbar={
<Toolbar>
<ToolbarContent>
<ToolbarGroup alignment={{ default: 'alignLeft' }}>
{leftAlignedToolbarGroup}
</ToolbarGroup>
<ToolbarGroup alignment={{ default: 'alignRight' }}>
{rightAlignedToolbarGroup}
</ToolbarGroup>
</ToolbarContent>
</Toolbar>
}
overScanCount={10}
footer={isPaused && <FooterButton />}
// onScroll={onScroll}
/>
</>
);
};

export default LogsTab;
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ import SelectedNodeDetailsTab from '~/concepts/pipelines/content/pipelinesDetail
import { PipelineRunTaskDetails, TaskReferenceMap } from '~/concepts/pipelines/content/types';
import SelectedNodeInputOutputTab from '~/concepts/pipelines/content/pipelinesDetails/pipelineRun/SelectedNodeInputOutputTab';
import SelectedNodeVolumeMountsTab from '~/concepts/pipelines/content/pipelinesDetails/pipelineRun/SelectedNodeVolumeMountsTab';
import LogsTab from '~/concepts/pipelines/content/pipelinesDetails/pipelineRun/LogsTab';

enum PipelineRunNodeTabs {
INPUT_OUTPUT = 'Input / Output',
// VISUALIZATIONS = 'Visualizations',
DETAILS = 'Details',
VOLUMES = 'Volumes',
// LOGS = 'Logs',
LOGS = 'Logs',
// POD = 'Pod',
// EVENTS = 'Events',
// ML_METADATA = 'ML Metadata',
Expand Down Expand Up @@ -59,7 +60,9 @@ const PipelineRunDrawerRightTabs: React.FC<PipelineRunDrawerRightTabsProps> = ({
<TabContent {...tabContentProps(PipelineRunNodeTabs.VOLUMES)}>
<SelectedNodeVolumeMountsTab task={task} />
</TabContent>
{/*<TabContent {...tabContentProps(PipelineRunNodeTabs.LOGS)}>TBD 5</TabContent>*/}
<TabContent {...tabContentProps(PipelineRunNodeTabs.LOGS)}>
<LogsTab task={task} />
</TabContent>
{/*<TabContent {...tabContentProps(PipelineRunNodeTabs.POD)}>TBD 6</TabContent>*/}
{/*<TabContent {...tabContentProps(PipelineRunNodeTabs.EVENTS)}>TBD 7</TabContent>*/}
{/*<TabContent {...tabContentProps(PipelineRunNodeTabs.ML_METADATA)}>TBD 8</TabContent>*/}
Expand Down
Loading