Skip to content

feat: add startup script logs to the ui #6558

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

Merged
merged 34 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
99d510c
Add startup script logs to the database
code-asher Feb 23, 2023
66c8ec3
Add coderd endpoints for startup script logs
code-asher Feb 23, 2023
1cc3e9d
Push startup script logs from agent
code-asher Feb 23, 2023
45d250f
Pull startup script logs on frontend
code-asher Feb 23, 2023
7fed360
Merge branch 'main' into startuplogs
kylecarbs Mar 10, 2023
7ce73aa
Rename queries
kylecarbs Mar 10, 2023
b86c400
Add constraint
kylecarbs Mar 11, 2023
0c4d2c3
Start creating log sending loop
kylecarbs Mar 13, 2023
1bb700f
Add log sending to the agent
kylecarbs Mar 13, 2023
736705f
Add tests for streaming logs
kylecarbs Mar 13, 2023
f741523
Shorten notify channel name
kylecarbs Mar 14, 2023
54c30be
Add FE
kylecarbs Mar 14, 2023
adb06ea
Improve bulk log performance
kylecarbs Mar 15, 2023
4061b13
Finish UI display
kylecarbs Mar 15, 2023
4c5b630
Fix startup log visibility
kylecarbs Mar 15, 2023
05d536c
Add warning for overflow
kylecarbs Mar 16, 2023
34fde1a
Fix agent queue logs overflow
kylecarbs Mar 17, 2023
379f1f4
Display staartup logs in a virtual DOM for performance
kylecarbs Mar 19, 2023
decde5c
Fix agent queue with loads of logs
kylecarbs Mar 20, 2023
d74457c
Merge branch 'main' into startuplogs
kylecarbs Mar 20, 2023
ac55f48
Fix authorize test
kylecarbs Mar 20, 2023
8d75963
Remove faulty test
kylecarbs Mar 20, 2023
cc715cd
Fix startup and shutdown reporting error
kylecarbs Mar 20, 2023
e3a4b2c
Fix gen
kylecarbs Mar 20, 2023
399dad7
Merge branch 'main' into startuplogs
kylecarbs Mar 22, 2023
45c0aca
Fix comments
kylecarbs Mar 22, 2023
5a0b15d
Periodically purge old database entries
kylecarbs Mar 23, 2023
b1b3fcb
Add test fixture for migration
kylecarbs Mar 23, 2023
6e1032c
Add Storybook
kylecarbs Mar 23, 2023
3762e8d
Check if there are logs when displaying features
kylecarbs Mar 23, 2023
f6b9fce
Fix startup component overflow gap
kylecarbs Mar 23, 2023
c48658c
Fix startup log wrapping
kylecarbs Mar 23, 2023
4ec1a0e
Merge branch 'main' into startuplogs
kylecarbs Mar 23, 2023
b55b7a1
Merge branch 'main' into startuplogs
kylecarbs Mar 23, 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
Improve bulk log performance
  • Loading branch information
kylecarbs committed Mar 15, 2023
commit adb06eafffb94f65f70d263ae673d10e9a614b96
48 changes: 15 additions & 33 deletions coderd/workspaceagents.go
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,6 @@ func (api *API) patchWorkspaceAgentStartupLogs(rw http.ResponseWriter, r *http.R
CreatedAfter: lowestID - 1,
})
if err != nil {

httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Failed to marshal startup logs notify message",
Detail: err.Error(),
Expand Down Expand Up @@ -374,32 +373,28 @@ func (api *API) workspaceAgentStartupLogs(rw http.ResponseWriter, r *http.Reques
ctx, wsNetConn := websocketNetConn(ctx, conn, websocket.MessageText)
defer wsNetConn.Close() // Also closes conn.

logIdsDone := make(map[int64]bool)

// The Go stdlib JSON encoder appends a newline character after message write.
encoder := json.NewEncoder(wsNetConn)
for _, provisionerJobLog := range logs {
logIdsDone[provisionerJobLog.ID] = true
err = encoder.Encode(convertWorkspaceAgentStartupLog(provisionerJobLog))
if err != nil {
return
}
err = encoder.Encode(convertWorkspaceAgentStartupLogs(logs))
if err != nil {
return
}
if agent.LifecycleState == database.WorkspaceAgentLifecycleStateReady {
// The startup script has finished running, so we can close the connection.
return
}

var (
bufferedLogs = make(chan *database.WorkspaceAgentStartupLog, 128)
// It's not impossible that
bufferedLogs = make(chan []database.WorkspaceAgentStartupLog, 128)
endOfLogs atomic.Bool
lastSentLogID atomic.Int64
)

sendLog := func(log *database.WorkspaceAgentStartupLog) {
sendLogs := func(logs []database.WorkspaceAgentStartupLog) {
select {
case bufferedLogs <- log:
lastSentLogID.Store(log.ID)
case bufferedLogs <- logs:
lastSentLogID.Store(logs[len(logs)-1].ID)
default:
logger.Warn(ctx, "workspace agent startup log overflowing channel")
}
Expand Down Expand Up @@ -427,13 +422,7 @@ func (api *API) workspaceAgentStartupLogs(rw http.ResponseWriter, r *http.Reques
logger.Warn(ctx, "failed to get workspace agent startup logs after", slog.Error(err))
return
}
for _, log := range logs {
if endOfLogs.Load() {
return
}
log := log
sendLog(&log)
}
sendLogs(logs)
}

if jlMsg.EndOfLogs {
Expand All @@ -446,10 +435,7 @@ func (api *API) workspaceAgentStartupLogs(rw http.ResponseWriter, r *http.Reques
logger.Warn(ctx, "get workspace agent startup logs after", slog.Error(err))
return
}
for _, log := range logs {
log := log
sendLog(&log)
}
sendLogs(logs)
bufferedLogs <- nil
}
},
Expand All @@ -468,19 +454,15 @@ func (api *API) workspaceAgentStartupLogs(rw http.ResponseWriter, r *http.Reques
case <-ctx.Done():
logger.Debug(context.Background(), "job logs context canceled")
return
case log, ok := <-bufferedLogs:
case logs, ok := <-bufferedLogs:
// A nil log is sent when complete!
if !ok || log == nil {
if !ok || logs == nil {
logger.Debug(context.Background(), "reached the end of published logs")
return
}
if logIdsDone[log.ID] {
logger.Debug(ctx, "subscribe duplicated log")
} else {
err = encoder.Encode(convertWorkspaceAgentStartupLog(*log))
if err != nil {
return
}
err = encoder.Encode(convertWorkspaceAgentStartupLogs(logs))
if err != nil {
return
}
}
}
Expand Down
20 changes: 20 additions & 0 deletions site/src/components/Resources/AgentRow.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import { VSCodeDesktopButton } from "components/VSCodeDesktopButton/VSCodeDeskto
import { useMachine } from "@xstate/react"
import { workspaceAgentLogsMachine } from "xServices/workspaceAgentLogs/workspaceAgentLogsXService"
import { Line, Logs } from "components/Logs/Logs"
import { Prism as SyntaxHighlighter } from "react-syntax-highlighter"
import { darcula } from "react-syntax-highlighter/dist/cjs/styles/prism"

export interface AgentRowProps {
agent: WorkspaceAgent
Expand Down Expand Up @@ -45,6 +47,8 @@ export const AgentRow: FC<AgentRowProps> = ({
context: { agentID: agent.id },
})

console.log("drac", darcula)

return (
<Stack direction="column" key={agent.id} spacing={0}>
<Stack
Expand Down Expand Up @@ -149,8 +153,18 @@ export const AgentRow: FC<AgentRowProps> = ({
</Stack>

<div>
Startup Script
<SyntaxHighlighter
style={darcula}
language="bash"
useInlineStyles={false}
codeTagProps={{ style: {} }}
>
{String(agent.startup_script)}
</SyntaxHighlighter>
{logsMachine.context.startupLogs && (
<Logs
className={styles.agentStartupLogs}
lines={logsMachine.context.startupLogs.map(
(log): Line => ({
level: "info",
Expand Down Expand Up @@ -195,4 +209,10 @@ const useStyles = makeStyles((theme) => ({
color: theme.palette.text.secondary,
marginTop: theme.spacing(0.5),
},

agentStartupLogs: {
maxHeight: 200,
display: "flex",
flexDirection: "column-reverse",
},
}))
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ export const workspaceAgentLogsMachine = createMachine(
id: "workspaceAgentLogsMachine",
schema: {
events: {} as {
type: "ADD_STARTUP_LOG"
log: TypesGen.WorkspaceAgentStartupLog
type: "ADD_STARTUP_LOGS"
logs: TypesGen.WorkspaceAgentStartupLog[]
},
context: {} as {
agentID: string
Expand Down Expand Up @@ -45,8 +45,8 @@ export const workspaceAgentLogsMachine = createMachine(
},
},
on: {
ADD_STARTUP_LOG: {
actions: "addStartupLog",
ADD_STARTUP_LOGS: {
actions: "addStartupLogs",
},
},
},
Expand All @@ -65,7 +65,7 @@ export const workspaceAgentLogsMachine = createMachine(
)
socket.binaryType = "blob"
socket.addEventListener("message", (event) => {
callback({ type: "ADD_STARTUP_LOG", log: JSON.parse(event.data) })
callback({ type: "ADD_STARTUP_LOGS", logs: JSON.parse(event.data) })
})
socket.addEventListener("error", () => {
reject(new Error("socket errored"))
Expand All @@ -80,10 +80,10 @@ export const workspaceAgentLogsMachine = createMachine(
assignStartupLogs: assign({
startupLogs: (_, { data }) => data,
}),
addStartupLog: assign({
addStartupLogs: assign({
startupLogs: (context, event) => {
const previousLogs = context.startupLogs ?? []
return [...previousLogs, event.log]
return [...previousLogs, ...event.logs]
},
}),
},
Expand Down