[supervisor] Provide initializer metrics for PVC

Author: Furisto

components/supervisor/pkg/metrics/metrics.go

@@ -12,6 +12,7 @@ import (
 
 type SupervisorMetrics struct {
 	IDEReadyDurationTotal *prometheus.HistogramVec
+	InitializerHistogram  *prometheus.HistogramVec
 }
 
 func NewMetrics() *SupervisorMetrics {
@@ -21,12 +22,18 @@ func NewMetrics() *SupervisorMetrics {
 			Help:    "the IDE startup time",
 			Buckets: []float64{0.1, 0.5, 1, 1.5, 2, 2.5, 5, 10},
 		}, []string{"kind"}),
+		InitializerHistogram: prometheus.NewHistogramVec(prometheus.HistogramOpts{
+			Name:    "supervisor_initializer_bytes_second",
+			Help:    "initializer speed in bytes per second",
+			Buckets: prometheus.ExponentialBuckets(1024*1024, 2, 12),
+		}, []string{"kind"}),
 	}
 }
 
 func (m *SupervisorMetrics) Register(registry *prometheus.Registry) error {
 	metrics := []prometheus.Collector{
 		m.IDEReadyDurationTotal,
+		m.InitializerHistogram,
 	}
 
 	for _, metric := range metrics {

components/supervisor/pkg/metrics/reporter.go

@@ -40,6 +40,7 @@ func NewGrpcMetricsReporter(gitpodHost string) *GrpcMetricsReporter {
 			"grpc_server_started_total":           true,
 			"grpc_server_handling_seconds":        true,
 			"supervisor_ide_ready_duration_total": true,
+			"initializer_bytes_second":            true,
 		},
 		values: make(map[string]float64),
 		addCounter: func(name string, labels map[string]string, value uint64) {

components/supervisor/pkg/supervisor/supervisor.go

@@ -330,7 +330,7 @@ func Run(options ...RunOption) {
 		shutdown = make(chan ShutdownReason, 1)
 	)
 	wg.Add(1)
-	go startContentInit(ctx, cfg, &wg, cstate)
+	go startContentInit(ctx, cfg, &wg, cstate, supervisorMetrics)
 	wg.Add(1)
 	go startAPIEndpoint(ctx, cfg, &wg, apiServices, tunneledPortsService, metricsReporter, apiEndpointOpts...)
 	wg.Add(1)
@@ -1354,7 +1354,7 @@ func startSSHServer(ctx context.Context, cfg *Config, wg *sync.WaitGroup, childP
 	}()
 }
 
-func startContentInit(ctx context.Context, cfg *Config, wg *sync.WaitGroup, cst ContentState) {
+func startContentInit(ctx context.Context, cfg *Config, wg *sync.WaitGroup, cst ContentState, metrics *metrics.SupervisorMetrics) {
 	defer wg.Done()
 	defer log.Info("supervisor: workspace content available")
 
@@ -1434,6 +1434,8 @@ func startContentInit(ctx context.Context, cfg *Config, wg *sync.WaitGroup, cst
 		return
 	}
 
+	recordInitializerMetrics("/workspace", metrics)
+
 	err = os.Remove(fn)
 	if os.IsNotExist(err) {
 		// file is gone - we're good
@@ -1448,6 +1450,27 @@ func startContentInit(ctx context.Context, cfg *Config, wg *sync.WaitGroup, cst
 	cst.MarkContentReady(src)
 }
 
+func recordInitializerMetrics(path string, metrics *metrics.SupervisorMetrics) {
+	readyFile := filepath.Join(path, ".gitpod/ready")
+
+	content, err := os.ReadFile(readyFile)
+	if err != nil {
+		log.WithError(err).Errorf("could not find ready file at %v", readyFile)
+		return
+	}
+
+	var ready csapi.WorkspaceReadyMessage
+	err = json.Unmarshal(content, &ready)
+	if err != nil {
+		log.WithError(err).Error("could not unmarshal ready")
+		return
+	}
+
+	for _, m := range ready.Metrics {
+		metrics.InitializerHistogram.WithLabelValues(m.Type).Observe(float64(m.Size) / m.Duration.Seconds())
+	}
+}
+
 func socketActivationForDocker(ctx context.Context, wg *sync.WaitGroup, term *terminal.Mux) {
 	defer wg.Done()