Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7287bd8

Browse files
committed
Reword metric descriptions for clarity
Signed-off-by: Danny Kopping <[email protected]>
1 parent 131307a commit 7287bd8

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

enterprise/coderd/prebuilds/metricscollector.go

+10-6
Original file line numberDiff line numberDiff line change
@@ -17,37 +17,41 @@ var (
1717
labels = []string{"template_name", "preset_name", "organization_name"}
1818
createdPrebuildsDesc = prometheus.NewDesc(
1919
"coderd_prebuilt_workspaces_created_total",
20-
"The number of prebuilt workspaces that have been created to meet the desired count set by presets.",
20+
"Total number of prebuilt workspaces that have been created to meet the desired instance count of each " +
21+
"template preset.",
2122
labels,
2223
nil,
2324
)
2425
failedPrebuildsDesc = prometheus.NewDesc(
2526
"coderd_prebuilt_workspaces_failed_total",
26-
"The number of prebuilt workspaces that failed to build.",
27+
"Total number of prebuilt workspaces that failed to build.",
2728
labels,
2829
nil,
2930
)
3031
claimedPrebuildsDesc = prometheus.NewDesc(
3132
"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.",
33+
"Total number of prebuilt workspaces which were claimed by users. Claiming refers to creating a workspace "+
34+
"with a preset selected for which eligible prebuilt workspaces are available and one is reassigned to a user.",
3335
labels,
3436
nil,
3537
)
3638
desiredPrebuildsDesc = prometheus.NewDesc(
3739
"coderd_prebuilt_workspaces_desired",
38-
"The number of prebuilt workspaces desired by each preset of each template.",
40+
"Target number of prebuilt workspaces that should be available for each template preset.",
3941
labels,
4042
nil,
4143
)
4244
runningPrebuildsDesc = prometheus.NewDesc(
4345
"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.",
46+
"Current number of prebuilt workspaces that are in a running state. These workspaces have started "+
47+
"successfully but may not yet be claimable by users (see coderd_prebuilt_workspaces_eligible).",
4548
labels,
4649
nil,
4750
)
4851
eligiblePrebuildsDesc = prometheus.NewDesc(
4952
"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.",
53+
"Current number of prebuilt workspaces that are eligible to be claimed by users. These are workspaces that " +
54+
"have completed their build process with their agent reporting 'ready' status.",
5155
labels,
5256
nil,
5357
)

0 commit comments

Comments
 (0)