8000 fix: avoid missed logs when streaming startup logs by mafredri · Pull Request #8029 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

fix: avoid missed logs when streaming startup logs #8029

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Jun 16, 2023
Merged

fix: avoid missed logs when streaming startup logs #8029

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
624e367
fix: Send startup log EOF and prevent lost messages
mafredri Jun 14, 2023
f35acd0
Merge branch 'main' into mafredri/fix-coderd-startup-log-eof
mafredri Jun 15, 2023
6fe8045
Ensure startup logs are closed on lifecycle state change
mafredri Jun 16, 2023
033262e
fix(codersdk): Fix startup log channel corruption
mafredri Jun 16, 2023
96c1ccd
Merge branch 'main' into mafredri/fix-coderd-startup-log-eof
mafredri Jun 16, 2023
1b58971
fix(site): Unshow the eof log line from WebUI
mafredri Jun 16, 2023
bcbec3e
Fix lint
mafredri Jun 16, 2023
eb7a7a3
Make EOF during lifecycle change mandatory
mafredri Jun 16, 2023
0dcfd73
Fix
mafredri Jun 16, 2023
a1a40f3
Fix after qp
mafredri Jun 16, 2023
9a49172
Merge branch 'main' into mafredri/fix-coderd-startup-log-eof
mafredri Jun 16, 2023
71f476a
Fix
mafredri Jun 16, 2023
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
Prev Previous commit
Next Next commit
fix(site): Unshow the eof log line from WebUI
  • Loading branch information
@mafredri
mafredri committed Jun 16, 2023
commit 1b589712f972ccec0733e8135a9e6ce2ef005564
13 changes: 9 additions & 4 deletions site/src/components/Resources/AgentRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import { FixedSizeList as List, ListOnScrollProps } from "react-window"
import { colors } from "theme/colors"
import { combineClasses } from "utils/combineClasses"
import {
LineWithID,
LineWithIDAndEOF,
workspaceAgentLogsMachine,
} from "xServices/workspaceAgentLogs/workspaceAgentLogsXService"
import {
Expand Down Expand Up @@ -54,7 +54,7 @@ export interface AgentRowProps {
hideVSCodeDesktopButton?: boolean
serverVersion: string
onUpdateAgent: () => void
storybookStartupLogs?: LineWithID[]
storybookStartupLogs?: LineWithIDAndEOF[]
storybookAgentMetadata?: WorkspaceAgentMetadata[]
}

Expand Down Expand Up @@ -98,7 +98,8 @@ export const AgentRow: FC<AgentRowProps> = ({
const { proxy } = useProxy()

const [showStartupLogs, setShowStartupLogs] = useState(
agent.lifecycle_state !== "ready" && hasStartupFeatures,
["starting", "start_timeout"].includes(agent.lifecycle_state) &&
hasStartupFeatures,
)
useEffect(() => {
setShowStartupLogs(agent.lifecycle_state !== "ready" && hasStartupFeatures)
Expand All @@ -123,13 +124,17 @@ export const AgentRow: FC<AgentRowProps> = ({
const startupLogs = useMemo(() => {
const allLogs = logsMachine.context.startupLogs || []

const logs = [...allLogs]
// Filter out eof, since we don't want to show an empty line to the
// user. The timesetamp could be used to show when the log ended in
// the future.
const logs = [...allLogs.filter((log) => !log.eof)]
if (agent.startup_logs_overflowed) {
logs.push({
id: -1,
level: "error",
output: "Startup logs exceeded the max size of 1MB!",
time: new Date().toISOString(),
eof: false,
})
}
return logs
Expand Down
11 changes: 7 additions & 4 deletions site/src/xServices/workspaceAgentLogs/workspaceAgentLogsXService.ts
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ import { Line } from "components/Logs/Logs"
// Logs are stored as the Line interface to make rendering
// much more efficient. Instead of mapping objects each time, we're
// able to just pass the array of logs to the component.
export interface LineWithID extends Line {
export interface LineWithIDAndEOF extends Line {
id: number
eof: boolean
}

export const workspaceAgentLogsMachine = createMachine(
Expand All @@ -18,7 +19,7 @@ export const workspaceAgentLogsMachine = createMachine(
events: {} as
| {
type: "ADD_STARTUP_LOGS"
logs: LineWithID[]
logs: LineWithIDAndEOF[]
}
| {
type: "FETCH_STARTUP_LOGS"
Expand All @@ -28,11 +29,11 @@ export const workspaceAgentLogsMachine = createMachine(
},
context: {} as {
agentID: string
startupLogs?: LineWithID[]
startupLogs?: LineWithIDAndEOF[]
},
services: {} as {
getStartupLogs: {
data: LineWithID[]
data: LineWithIDAndEOF[]
}
},
},
Expand Down Expand Up @@ -82,6 +83,7 @@ export const workspaceAgentLogsMachine = createMachine(
level: log.level || "info",
output: log.output,
time: log.created_at,
eof: log.eof,
})),
),
streamStartupLogs: (ctx) => async (callback) => {
Expand All @@ -100,6 +102,7 @@ export const workspaceAgentLogsMachine = createMachine(
level: "info" as TypesGen.LogLevel,
output: log.output,
time: log.created_at,
eof: log.eof,
})),
})
},
Expand Down
0