fixup! [api] Expose session.Metrics.InitializerMetrics

Tool: gitpod/catfood.gitpod.cloud

Author: geropl

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

@@ -946,7 +946,7 @@ message WorkspaceSession {
 
   // Add these new message definitions
   message InitializerMetric {
-    // Duration in nanoseconds (standard protobuf duration)
+    // Duration in seconds
     google.protobuf.Duration duration = 1;
 
     // Size in bytes
@@ -955,22 +955,31 @@ message WorkspaceSession {
 
   message InitializerMetrics {
     // Git contains metrics for the git initializer step
+    // This is set whenenver a `git clone` is issued (mostly on first workspace start)
     InitializerMetric git = 1;
 
     // FileDownload contains metrics for the file download initializer step
+    // This is set for injecting "additionalFiles" into the workspace.
     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
+    // This is set on subsequent workspace starts, when the file system is restored from backup.
     InitializerMetric backup = 4;
 
     // Prebuild contains metrics for the prebuild initializer step
+    // This is set if the workspace is based on a prebuild.
     InitializerMetric prebuild = 5;
 
     // Composite contains metrics for the composite initializer step
+    // This reports the total if multiple steps are run to initialize the workspace content.
+    // Examples are:
+    //  - "additionalFiles" injected into the workspace
+    //  - "additionalRepositories" configured
+    //  - incremental Prebuilds
     InitializerMetric composite = 6;
   }