Skip to content

[prebuilds] add metrics for prebuilds 10383 #10435

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 1 commit into from
Jun 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion components/server/ee/src/workspace/workspace-factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +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 {
@inject(LicenseEvaluator) protected readonly licenseEvaluator: LicenseEvaluator;
Expand Down Expand Up @@ -177,6 +177,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}`,
Expand Down
10 changes: 10 additions & 0 deletions components/server/src/prometheus-metrics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
5 changes: 5 additions & 0 deletions components/ws-manager-bridge/ee/src/prebuild-updater-db.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -79,6 +80,10 @@ export class PrebuildUpdaterDB implements PrebuildUpdater {
span.setTag("updatePrebuildWorkspace.prebuild.state", updatedPrebuild.state);
span.setTag("updatePrebuildWorkspace.prebuild.error", updatedPrebuild.error);

if (writeToDB && updatedPrebuild.state && terminatingStates.includes(updatedPrebuild.state)) {
this.prometheusExporter.increasePrebuildsCompletedCounter(updatedPrebuild.state);
}

if (writeToDB) {
await this.workspaceDB.trace({ span }).storePrebuiltWorkspace(updatedPrebuild);
}
Expand Down
11 changes: 11 additions & 0 deletions components/ws-manager-bridge/src/prometheus-metrics-exporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
Expand Down Expand Up @@ -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"],
});
}

observeWorkspaceStartupTime(instance: WorkspaceInstance): void {
Expand Down Expand Up @@ -142,4 +149,8 @@ export class PrometheusMetricsExporter {
.labels(String(dbWrite), workspaceCluster, WorkspaceType[type], outcome)
.observe(durationSeconds);
}

increasePrebuildsCompletedCounter(state: string) {
this.prebuildsCompletedTotal.inc({ state });
}
}