add metrics

Author: Laurie T. Malau

components/server/ee/src/workspace/workspace-factory.ts

@@ -30,6 +30,7 @@ import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { HostContextProvider } from "../../../src/auth/host-context-provider";
 import { UserDB } from "@gitpod/gitpod-db/lib";
 import { UserCounter } from "../user/user-counter";
+import { increasePrebuildsStartedCounter } from "../../../src/prometheus-metrics";
 
 @injectable()
 export class WorkspaceFactoryEE extends WorkspaceFactory {
@@ -177,6 +178,10 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
                 statusVersion: 0,
             });
 
+            if (pws) {
+                increasePrebuildsStartedCounter();
+            }
+
             log.debug(
                 { userId: user.id, workspaceId: ws.id },
                 `Registered workspace prebuild: ${pws.id} for ${commitContext.repository.cloneUrl}:${commitContext.revision}`,

components/server/src/prometheus-metrics.ts

@@ -151,3 +151,13 @@ const instanceStartsFailedTotal = new prometheusClient.Counter({
 export function increaseFailedInstanceStartCounter(reason: "clusterSelectionFailed" | "startOnClusterFailed") {
     instanceStartsFailedTotal.inc({ reason });
 }
+
+const prebuildsStartedTotal = new prometheusClient.Counter({
+    name: "gitpod_prebuilds_started_total",
+    help: "Counter of total prebuilds started.",
+    registers: [prometheusClient.register],
+});
+
+export function increasePrebuildsStartedCounter() {
+    prebuildsStartedTotal.inc();
+}

components/ws-manager-bridge/ee/src/prebuild-updater-db.ts

@@ -70,6 +70,7 @@ export class PrebuildUpdaterDB implements PrebuildUpdater {
             prebuild.statusVersion = status.statusVersion;
 
             const update = this.prebuildStateMapper.mapWorkspaceStatusToPrebuild(status);
+            const terminatingStates = ["available", "timeout", "aborted", "failed"];
             if (update) {
                 const updatedPrebuild = {
                     ...prebuild,
@@ -79,6 +80,10 @@ export class PrebuildUpdaterDB implements PrebuildUpdater {
                 span.setTag("updatePrebuildWorkspace.prebuild.state", updatedPrebuild.state);
                 span.setTag("updatePrebuildWorkspace.prebuild.error", updatedPrebuild.error);
 
+                if (updatedPrebuild.state && terminatingStates.includes(updatedPrebuild.state)) {
+                    this.prometheusExporter.increasePrebuildsCompletedCounter(updatedPrebuild.state, writeToDB);
+                }
+
                 if (writeToDB) {
                     await this.workspaceDB.trace({ span }).storePrebuiltWorkspace(updatedPrebuild);
                 }

components/ws-manager-bridge/src/prometheus-metrics-exporter.ts

@@ -18,6 +18,7 @@ export class PrometheusMetricsExporter {
     protected readonly clusterCordoned: prom.Gauge<string>;
     protected readonly statusUpdatesTotal: prom.Counter<string>;
     protected readonly stalePrebuildEventsTotal: prom.Counter<string>;
+    protected readonly prebuildsCompletedTotal: prom.Counter<string>;
 
     protected readonly workspaceInstanceUpdateStartedTotal: prom.Counter<string>;
     protected readonly workspaceInstanceUpdateCompletedSeconds: prom.Histogram<string>;
@@ -73,6 +74,12 @@ export class PrometheusMetricsExporter {
             labelNames: ["db_write", "workspace_cluster", "workspace_instance_type", "outcome"],
             buckets: prom.exponentialBuckets(2, 2, 8),
         });
+
+        this.prebuildsCompletedTotal = new prom.Counter({
+            name: "gitpod_prebuilds_completed_total",
+            help: "Counter of total prebuilds ended.",
+            labelNames: ["state", "isGoverning"],
+        });
     }
 
     observeWorkspaceStartupTime(instance: WorkspaceInstance): void {
@@ -142,4 +149,8 @@ export class PrometheusMetricsExporter {
             .labels(String(dbWrite), workspaceCluster, WorkspaceType[type], outcome)
             .observe(durationSeconds);
     }
+
+    increasePrebuildsCompletedCounter(state: string, isGoverning: boolean) {
+        this.prebuildsCompletedTotal.labels(state, String(isGoverning)).inc();
+    }
 }