[api] Expose session.Metrics.InitializerMetrics

Tool: gitpod/catfood.gitpod.cloud

Author: geropl

components/gitpod-db/src/typeorm/workspace-db-impl.ts

@@ -63,7 +63,7 @@ import { TypeORM } from "./typeorm";
 import { ApplicationError, ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { DBProject } from "./entity/db-project";
 import { PrebuiltWorkspaceWithWorkspace } from "@gitpod/gitpod-protocol/src/protocol";
-import { DBWorkspaceInstanceMetrics } from "./entity/db-workspace-instance-metrics-db";
+import { DBWorkspaceInstanceMetrics } from "./entity/db-workspace-instance-metrics";
 
 type RawTo<T> = (instance: WorkspaceInstance, ws: Workspace) => T;
 interface OrderBy {
@@ -471,6 +471,7 @@ export class TypeORMWorkspaceDBImpl extends TransactionalDBImpl<WorkspaceDB> imp
         const sessions = await workspaceInstanceRepo
             .createQueryBuilder("wsi")
             .leftJoinAndMapOne("wsi.workspace", DBWorkspace, "ws", "ws.id = wsi.workspaceId")
+            .leftJoinAndMapOne("wsi.metrics", DBWorkspaceInstanceMetrics, "wsim", "wsim.instanceId = wsi.id")
             .where("ws.organizationId = :organizationId", { organizationId })
             .andWhere("wsi.creationTime >= :periodStart", { periodStart: periodStart.toISOString() })
             .andWhere("wsi.creationTime <= :periodEnd", { periodEnd: periodEnd.toISOString() })
@@ -479,13 +480,19 @@ export class TypeORMWorkspaceDBImpl extends TransactionalDBImpl<WorkspaceDB> imp
             .take(limit)
             .getMany();
 
-        const resultSessions: { instance: WorkspaceInstance; workspace: Workspace }[] = [];
+        const resultSessions: {
+            instance: WorkspaceInstance;
+            workspace: Workspace;
+            metrics?: WorkspaceInstanceMetrics;
+        }[] = [];
         for (const session of sessions) {
             resultSessions.push({
                 workspace: (session as any).workspace,
                 instance: session,
+                metrics: (session as any).metrics,
             });
             delete (session as any).workspace;
+            delete (session as any).metrics;
         }
         return resultSessions;
     }

components/gitpod-protocol/src/protocol.ts

@@ -4,7 +4,7 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { WorkspaceInstance, PortVisibility, PortProtocol } from "./workspace-instance";
+import { WorkspaceInstance, PortVisibility, PortProtocol, WorkspaceInstanceMetrics } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
 import { Project } from "./teams-projects-protocol";
 import { createHash } from "crypto";
@@ -1390,6 +1390,7 @@ export namespace WorkspaceInstancePortsChangedEvent {
 export interface WorkspaceSession {
     workspace: Workspace;
     instance: WorkspaceInstance;
+    metrics?: WorkspaceInstanceMetrics;
 }
 export interface WorkspaceInfo {
     workspace: Workspace;

components/gitpod-protocol/src/workspace-instance.ts

@@ -332,23 +332,26 @@ export interface ImageBuildLogInfo {
  * Holds metrics about the workspace instance
  */
 export interface WorkspaceInstanceMetrics {
-    image?: Partial<{
-        /**
-         * the total size of the image in bytes (includes Gitpod-specific layers like IDE)
-         */
-        totalSize: number;
-        /**
-         * the size of the workspace image in bytes
-         */
-        workspaceImageSize: number;
-    }>;
+    image?: ImageMetrics;
 
     /**
      * Metrics about the workspace initializer
      */
     initializerMetrics?: InitializerMetrics;
 }
 
+export interface ImageMetrics {
+    /**
+     * the total size of the image in bytes (includes Gitpod-specific layers like IDE)
+     */
+    totalSize?: number;
+
+    /**
+     * the size of the workspace image in bytes
+     */
+    workspaceImageSize?: number;
+}
+
 export interface InitializerMetrics {
     git?: InitializerMetric;
     fileDownload?: InitializerMetric;

components/public-api/gitpod/v1/workspace.proto

@@ -939,6 +939,39 @@ message WorkspaceSession {
 
     // total_image_size is the total size of the image in bytes (includes Gitpod-specific layers like IDE)
     int64 total_image_size = 2;
+
+    // initializer_metrics are all metrics exported from the content initializer on workspace start
+    InitializerMetrics initializer_metrics = 3;
+  }
+
+  // Add these new message definitions
+  message InitializerMetric {
+    // Duration in nanoseconds (standard protobuf duration)
+    google.protobuf.Duration duration = 1;
+
+    // Size in bytes
+    uint64 size = 2;
+  }
+
+  message InitializerMetrics {
+    // Git contains metrics for the git initializer step
+    InitializerMetric git = 1;
+
+    // FileDownload contains metrics for the file download initializer step
+    InitializerMetric file_download = 2;
+
+    // Snapshot contains metrics for the snapshot initializer step
+    // This used for workspaces started from snapshots.
+    InitializerMetric snapshot = 3;
+
+    // Backup contains metrics for the backup initializer step
+    InitializerMetric backup = 4;
+
+    // Prebuild contains metrics for the prebuild initializer step
+    InitializerMetric prebuild = 5;
+
+    // Composite contains metrics for the composite initializer step
+    InitializerMetric composite = 6;
   }
 
   string id = 1;