Skip to content

Commit 6b6fea4

Browse files
dannykoppingdannykopping
committed
Renaming prebuilds to "prebuilt workspaces" in metrics
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
1 parent 5579683 commit 6b6fea4

File tree

2 files changed

+37
-44
lines changed

2 files changed

+37
-44
lines changed

‎enterprise/coderd/prebuilds/metricscollector.go

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,44 +16,38 @@ import (
1616
var (
1717
labels = []string{"template_name", "preset_name", "organization_name"}
1818
createdPrebuildsDesc = prometheus.NewDesc(
19-
"coderd_prebuilds_created_total",
20-
"The number of prebuilds that have been created to meet the desired count set by presets.",
19+
"coderd_prebuilt_workspaces_created_total",
20+
"The number of prebuilt workspaces that have been created to meet the desired count set by presets.",
2121
labels,
2222
nil,
2323
)
2424
failedPrebuildsDesc = prometheus.NewDesc(
25-
"coderd_prebuilds_failed_total",
26-
"The number of prebuilds that failed to build during creation.",
25+
"coderd_prebuilt_workspaces_failed_total",
26+
"The number of prebuilt workspaces that failed to build.",
2727
labels,
2828
nil,
2929
)
3030
claimedPrebuildsDesc = prometheus.NewDesc(
31-
"coderd_prebuilds_claimed_total",
32-
"The number of prebuilds that were claimed by a user. Each count means that a user created a workspace using a preset and was assigned a prebuild instead of a brand new workspace.",
33-
labels,
34-
nil,
35-
)
36-
usedPresetsDesc = prometheus.NewDesc(
37-
"coderd_prebuilds_used_presets",
38-
"The number of times a preset was used to build a prebuild.",
31+
"coderd_prebuilt_workspaces_claimed_total",
32+
"The number of prebuilt workspaces that were claimed by a user. Each count means that a user created a workspace using a preset and claimed a prebuilt workspace instead of a brand new workspace being created.",
3933
labels,
4034
nil,
4135
)
4236
desiredPrebuildsDesc = prometheus.NewDesc(
43-
"coderd_prebuilds_desired",
44-
"The number of prebuilds desired by each preset of each template.",
37+
"coderd_prebuilt_workspaces_desired",
38+
"The number of prebuilt workspaces desired by each preset of each template.",
4539
labels,
4640
nil,
4741
)
4842
runningPrebuildsDesc = prometheus.NewDesc(
49-
"coderd_prebuilds_running",
50-
"The number of prebuilds that are currently running. Running prebuilds have successfully started, but they may not be ready to be claimed by a user yet.",
43+
"coderd_prebuilt_workspaces_running",
44+
"The number of prebuilt workspaces that are currently running. Running prebuilt workspaces have successfully started, but includes both eligible and ineligible workspaces.",
5145
labels,
5246
nil,
5347
)
5448
eligiblePrebuildsDesc = prometheus.NewDesc(
55-
"coderd_prebuilds_eligible",
56-
"The number of eligible prebuilds. Eligible prebuilds are prebuilds that are ready to be claimed by a user.",
49+
"coderd_prebuilt_workspaces_eligible",
50+
"The number of eligible prebuilt workspaces. Eligible prebuilt workspaces are ones whose agent is marked 'ready', and can be claimed by a user.",
5751
labels,
5852
nil,
5953
)
@@ -79,7 +73,6 @@ func (*MetricsCollector) Describe(descCh chan<- *prometheus.Desc) {
7973
descCh <- createdPrebuildsDesc
8074
descCh <- failedPrebuildsDesc
8175
descCh <- claimedPrebuildsDesc
82-
descCh <- usedPresetsDesc
8376
descCh <- desiredPrebuildsDesc
8477
descCh <- runningPrebuildsDesc
8578
descCh <- eligiblePrebuildsDesc

‎enterprise/coderd/prebuilds/metricscollector_test.go

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ func TestMetricsCollector(t *testing.T) {
5858
// * a prebuild that was claimed should not be deemed running, not eligible.
5959
ownerIDs: []uuid.UUID{agplprebuilds.SystemUserID, uuid.New()},
6060
metrics: []metricCheck{
61-
{"coderd_prebuilds_created_total", ptr.To(1.0), true},
62-
{"coderd_prebuilds_desired", ptr.To(1.0), false},
63-
// {"coderd_prebuilds_running", ptr.To(0.0), false},
64-
// {"coderd_prebuilds_eligible", ptr.To(0.0), false},
61+
{"coderd_prebuilt_workspaces_created_total", ptr.To(1.0), true},
62+
{"coderd_prebuilt_workspaces_desired", ptr.To(1.0), false},
63+
{"coderd_prebuilt_workspaces_running", ptr.To(0.0), false},
64+
{"coderd_prebuilt_workspaces_eligible", ptr.To(0.0), false},
6565
},
6666
templateDeleted: []bool{false},
6767
},
@@ -72,10 +72,10 @@ func TestMetricsCollector(t *testing.T) {
7272
initiatorIDs: []uuid.UUID{agplprebuilds.SystemUserID},
7373
ownerIDs: []uuid.UUID{agplprebuilds.SystemUserID},
7474
metrics: []metricCheck{
75-
{"coderd_prebuilds_created_total", ptr.To(1.0), true},
76-
{"coderd_prebuilds_desired", ptr.To(1.0), false},
77-
{"coderd_prebuilds_running", ptr.To(1.0), false},
78-
{"coderd_prebuilds_eligible", ptr.To(0.0), false},
75+
{"coderd_prebuilt_workspaces_created_total", ptr.To(1.0), true},
76+
{"coderd_prebuilt_workspaces_desired", ptr.To(1.0), false},
77+
{"coderd_prebuilt_workspaces_running", ptr.To(1.0), false},
78+
{"coderd_prebuilt_workspaces_eligible", ptr.To(0.0), false},
7979
},
8080
templateDeleted: []bool{false},
8181
},
@@ -86,26 +86,26 @@ func TestMetricsCollector(t *testing.T) {
8686
initiatorIDs: []uuid.UUID{agplprebuilds.SystemUserID},
8787
ownerIDs: []uuid.UUID{agplprebuilds.SystemUserID, uuid.New()},
8888
metrics: []metricCheck{
89-
{"coderd_prebuilds_created_total", ptr.To(1.0), true},
90-
{"coderd_prebuilds_failed_total", ptr.To(1.0), true},
91-
{"coderd_prebuilds_desired", ptr.To(1.0), false},
92-
{"coderd_prebuilds_running", ptr.To(0.0), false},
93-
{"coderd_prebuilds_eligible", ptr.To(0.0), false},
89+
{"coderd_prebuilt_workspaces_created_total", ptr.To(1.0), true},
90+
{"coderd_prebuilt_workspaces_failed_total", ptr.To(1.0), true},
91+
{"coderd_prebuilt_workspaces_desired", ptr.To(1.0), false},
92+
{"coderd_prebuilt_workspaces_running", ptr.To(0.0), false},
93+
{"coderd_prebuilt_workspaces_eligible", ptr.To(0.0), false},
9494
},
9595
templateDeleted: []bool{false},
9696
},
9797
{
98-
name: "prebuild assigned",
98+
name: "prebuild claimed",
9999
transitions: allTransitions,
100100
jobStatuses: allJobStatuses,
101101
initiatorIDs: []uuid.UUID{agplprebuilds.SystemUserID},
102102
ownerIDs: []uuid.UUID{uuid.New()},
103103
metrics: []metricCheck{
104-
{"coderd_prebuilds_created_total", ptr.To(1.0), true},
105-
{"coderd_prebuilds_claimed_total", ptr.To(1.0), true},
106-
{"coderd_prebuilds_desired", ptr.To(1.0), false},
107-
{"coderd_prebuilds_running", ptr.To(0.0), false},
108-
{"coderd_prebuilds_eligible", ptr.To(0.0), false},
104+
{"coderd_prebuilt_workspaces_created_total", ptr.To(1.0), true},
105+
{"coderd_prebuilt_workspaces_claimed_total", ptr.To(1.0), true},
106+
{"coderd_prebuilt_workspaces_desired", ptr.To(1.0), false},
107+
{"coderd_prebuilt_workspaces_running", ptr.To(0.0), false},
108+
{"coderd_prebuilt_workspaces_eligible", ptr.To(0.0), false},
109109
},
110110
templateDeleted: []bool{false},
111111
},
@@ -116,9 +116,9 @@ func TestMetricsCollector(t *testing.T) {
116116
initiatorIDs: []uuid.UUID{uuid.New()},
117117
ownerIDs: []uuid.UUID{uuid.New()},
118118
metrics: []metricCheck{
119-
{"coderd_prebuilds_desired", ptr.To(1.0), false},
120-
{"coderd_prebuilds_running", ptr.To(0.0), false},
121-
{"coderd_prebuilds_eligible", ptr.To(0.0), false},
119+
{"coderd_prebuilt_workspaces_desired", ptr.To(1.0), false},
120+
{"coderd_prebuilt_workspaces_running", ptr.To(0.0), false},
121+
{"coderd_prebuilt_workspaces_eligible", ptr.To(0.0), false},
122122
},
123123
templateDeleted: []bool{false},
124124
},
@@ -129,7 +129,7 @@ func TestMetricsCollector(t *testing.T) {
129129
initiatorIDs: []uuid.UUID{agplprebuilds.SystemUserID},
130130
ownerIDs: []uuid.UUID{agplprebuilds.SystemUserID, uuid.New()},
131131
metrics: []metricCheck{
132-
{"coderd_prebuilds_desired", ptr.To(0.0), false},
132+
{"coderd_prebuilt_workspaces_desired", ptr.To(0.0), false},
133133
},
134134
templateDeleted: []bool{true},
135135
},
@@ -140,8 +140,8 @@ func TestMetricsCollector(t *testing.T) {
140140
initiatorIDs: []uuid.UUID{agplprebuilds.SystemUserID},
141141
ownerIDs: []uuid.UUID{agplprebuilds.SystemUserID},
142142
metrics: []metricCheck{
143-
{"coderd_prebuilds_running", ptr.To(1.0), false},
144-
{"coderd_prebuilds_eligible", ptr.To(0.0), false},
143+
{"coderd_prebuilt_workspaces_running", ptr.To(1.0), false},
144+
{"coderd_prebuilt_workspaces_eligible", ptr.To(0.0), false},
145145
},
146146
templateDeleted: []bool{true},
147147
},

0 commit comments

Comments
 (0)