8000 feat(site): add agent connection timings by BrunoQuaresma · Pull Request #15276 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

feat(site): add agent connection timings #15276

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 20 commits into from
Nov 1, 2024
Merged

feat(site): add agent connection timings #15276

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
8f15ca1
Add agent ID and name on agent script timing response
BrunoQuaresma Oct 25, 2024
8ac895f
Add agent connection timings to the response
BrunoQuaresma Oct 25, 2024
124d149
Remove unused modules
BrunoQuaresma Oct 29, 2024
0ff2be9
Merge branch 'main' of https://github.com/coder/coder into bq/add-age…
BrunoQuaresma Oct 29, 2024
d00a00b
Display agent timings
BrunoQuaresma Oct 29, 2024
69b181c
Display agent connection timings
BrunoQuaresma Oct 29, 2024
3e1170c
Apply suggestions from code review
BrunoQuaresma Oct 30, 2024
ab8792f
Fix fmt
BrunoQuaresma Oct 30, 2024
0b685a9
Improve tests
BrunoQuaresma Oct 30, 2024
709b669
Merge branch 'main' of https://github.com/coder/coder into bq/add-age…
BrunoQuaresma Oct 31, 2024
d9fc453
Return error if agent or script are not found
BrunoQuaresma Oct 31, 2024
1bed074
Change the agent stage label to agent ()
BrunoQuaresma Oct 31, 2024
4bd6538
Fix storybook
BrunoQuaresma Oct 31, 2024
c368a57
Merge branch 'main' of https://github.com/coder/coder into bq/add-age…
BrunoQuaresma Nov 1, 2024
f59a87d
Remove duplicate vscode config
BrunoQuaresma Nov 1, 2024
91be0dc
Apply PR suggested changes
BrunoQuaresma Nov 1, 2024
044f6e5
Fix chart navigation
BrunoQuaresma Nov 1, 2024
e8bbecd
Fix fmt
BrunoQuaresma Nov 1, 2024
e1a61d8
Apply PR reviews
BrunoQuaresma Nov 1, 2024
ce6f507
Fix test
BrunoQuaresma Nov 1, 2024
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
Apply PR reviews
  • Loading branch information
@BrunoQuaresma
BrunoQuaresma committed Nov 1, 2024
commit e1a61d8794e6876851952279219f73a1b85c0b47
30 changes: 27 additions & 3 deletions coderd/apidoc/docs.go
View file
Open in desktop

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

30 changes: 27 additions & 3 deletions coderd/apidoc/swagger.json
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions coderd/workspacebuilds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -979,7 +979,7 @@ func (api *API) buildTimings(ctx context.Context, build database.WorkspaceBuild)
for _, t := range provisionerTimings {
res.ProvisionerTimings = append(res.ProvisionerTimings, codersdk.ProvisionerTiming{
JobID: t.JobID,
Stage: string(t.Stage),
Stage: codersdk.TimingStage(t.Stage),
Source: t.Source,
Action: t.Action,
Resource: t.Resource,
Expand All @@ -992,7 +992,7 @@ func (api *API) buildTimings(ctx context.Context, build database.WorkspaceBuild)
StartedAt: t.StartedAt,
EndedAt: t.EndedAt,
ExitCode: t.ExitCode,
Stage: string(t.Stage),
Stage: codersdk.TimingStage(t.Stage),
Status: string(t.Status),
DisplayName: t.DisplayName,
WorkspaceAgentID: t.WorkspaceAgentID.String(),
Expand All @@ -1004,7 +1004,7 @@ func (api *API) buildTimings(ctx context.Context, build database.WorkspaceBuild)
WorkspaceAgentID: agent.ID.String(),
WorkspaceAgentName: agent.Name,
StartedAt: agent.CreatedAt,
Stage: "connect",
Stage: codersdk.TimingStageConnect,
EndedAt: agent.FirstConnectedAt.Time,
})
}
Expand Down
36 changes: 29 additions & 7 deletions coderd/workspacebuilds_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1382,6 +1382,35 @@ func TestWorkspaceBuildTimings(t *testing.T) {
t.Run("AgentConnectionTimings", func(t *testing.T) {
t.Parallel()

// Given: a build with an agent
build := makeBuild()
resource := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{
JobID: build.JobID,
})
agent := dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{
ResourceID: resource.ID,
})

// When: fetching timings for the build
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
res, err := client.WorkspaceBuildTimings(ctx, build.ID)
require.NoError(t, err)

// Then: return a response with the expected timings
require.Len(t, res.AgentConnectionTimings, 1)
for i := range res.ProvisionerTimings {
timingRes := res.AgentConnectionTimings[i]
require.Equal(t, agent.ID.String(), timingRes.WorkspaceAgentID)
require.Equal(t, agent.Name, timingRes.WorkspaceAgentName)
require.NotEmpty(t, timingRes.StartedAt)
require.NotEmpty(t, timingRes.EndedAt)
}
})

t.Run("MultipleAgents", func(t *testing.T) {
t.Parallel()

// Given: a build with multiple agents
build := makeBuild()
resource := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{
Expand All @@ -1402,12 +1431,5 @@ func TestWorkspaceBuildTimings(t *testing.T) {

// Then: return a response with the expected timings
require.Len(t, res.AgentConnectionTimings, 5)
for i := range res.ProvisionerTimings {
timingRes := res.AgentConnectionTimings[i]
require.Equal(t, agents[i].ID.String(), timingRes.WorkspaceAgentID)
require.Equal(t, agents[i].Name, timingRes.WorkspaceAgentName)
require.NotEmpty(t, timingRes.StartedAt)
require.NotEmpty(t, timingRes.EndedAt)
}
})
}
60 changes: 39 additions & 21 deletions codersdk/workspacebuilds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,37 +175,55 @@ func (c *Client) WorkspaceBuildParameters(ctx context.Context, build uuid.UUID)
return params, json.NewDecoder(res.Body).Decode(&params)
}

type TimingStage string

const (
// Based on ProvisionerJobTimingStage
TimingStageInit TimingStage = "init"
TimingStagePlan TimingStage = "plan"
TimingStageGraph TimingStage = "graph"
TimingStageApply TimingStage = "apply"
// Based on WorkspaceAgentScriptTimingStage
TimingStageStart TimingStage = "start"
TimingStageStop TimingStage = "stop"
TimingStageCron TimingStage = "cron"
// Custom timing stage to represent the time taken to connect to an agent
TimingStageConnect TimingStage = "connect"
)

type ProvisionerTiming struct {
JobID uuid.UUID `json:"job_id" format:"uuid"`
StartedAt time.Time `json:"started_at" format:"date-time"`
EndedAt time.Time `json:"ended_at" format:"date-time"`
Stage string `json:"stage"`
Source string `json:"source"`
Action string `json:"action"`
Resource string `json:"resource"`
JobID uuid.UUID `json:"job_id" format:"uuid"`
StartedAt time.Time `json:"started_at" format:"date-time"`
EndedAt time.Time `json:"ended_at" format:"date-time"`
Stage TimingStage `json:"stage"`
Source string `json:"source"`
Action string `json:"action"`
Resource string `json:"resource"`
}

type AgentScriptTiming struct {
StartedAt time.Time `json:"started_at" format:"date-time"`
EndedAt time.Time `json:"ended_at" format:"date-time"`
ExitCode int32 `json:"exit_code"`
Stage string `json:"stage"`
Status string `json:"status"`
DisplayName string `json:"display_name"`
WorkspaceAgentID string `json:"workspace_agent_id"`
WorkspaceAgentName string `json:"workspace_agent_name"`
StartedAt time.Time `json:"started_at" format:"date-time"`
EndedAt time.Time `json:"ended_at" format:"date-time"`
ExitCode int32 `json:"exit_code"`
Stage TimingStage `json:"stage"`
Status string `json:"status"`
DisplayName string `json:"display_name"`
WorkspaceAgentID string `json:"workspace_agent_id"`
WorkspaceAgentName string `json:"workspace_agent_name"`
}

type AgentConnectionTiming struct {
StartedAt time.Time `json:"started_at" format:"date-time"`
EndedAt time.Time `json:"ended_at" format:"date-time"`
Stage string `json:"stage"`
WorkspaceAgentID string `json:"workspace_agent_id"`
WorkspaceAgentName string `json:"workspace_agent_name"`
StartedAt time.Time `json:"started_at" format:"date-time"`
EndedAt time.Time `json:"ended_at" format:"date-time"`
Stage TimingStage `json:"stage"`
WorkspaceAgentID string `json:"workspace_agent_id"`
WorkspaceAgentName string `json:"workspace_agent_name"`
}

type WorkspaceBuildTimings struct {
ProvisionerTimings []ProvisionerTiming `json:"provisioner_timings"`
ProvisionerTimings []ProvisionerTiming `json:"provisioner_timings"`
// TODO: Consolidate agent-related timing metrics into a single struct when
// updating the API version
AgentScriptTimings []AgentScriptTiming `json:"agent_script_timings"`
AgentConnectionTimings []AgentConnectionTiming `json:"agent_connection_timings"`
}
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/api/builds.md
View file
Open in desktop

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

Loading
Loading
0