UUID for each sandbox event (#1394)

Author: sitole

packages/clickhouse/migrations/20251017213616_sandbox_events_id.sql

@@ -0,0 +1,18 @@
+-- +goose Up
+
+-- ID field with default UUID for local
+ALTER TABLE sandbox_events_local
+    ADD COLUMN id UUID DEFAULT generateUUIDv4();
+
+-- ID field with default UUID for global
+ALTER TABLE sandbox_events
+    ADD COLUMN id UUID DEFAULT generateUUIDv4();
+
+-- +goose Down
+-- Remove ID column from local
+ALTER TABLE sandbox_events_local
+DROP COLUMN IF EXISTS id;
+
+-- Remove ID column from global
+ALTER TABLE sandbox_events
+DROP COLUMN IF EXISTS id;

packages/clickhouse/pkg/batcher/product_usage_insert_batcher.go

@@ -33,7 +33,8 @@ const InsertSandboxEventQuery = `INSERT INTO sandbox_events
     event_label,
     event_data,
     type,
-    version
+    version,
+    id
 )
 VALUES (
     ?,
@@ -46,6 +47,7 @@ VALUES (
     ?,
     ?,
     ?,
+    ?,
     ?
 )`
 
@@ -89,6 +91,7 @@ func (b *SandboxEventInsertBatcher) processInsertSandboxEventsBatch(events []cli
 			event.EventData,
 			event.Type,
 			event.Version,
+			event.ID,
 		)
 		if err != nil {
 			return fmt.Errorf("error appending %d product usage event to batch: %w", len(events), err)

packages/clickhouse/pkg/batcher/sandbox_events_insert_batcher.go

@@ -10,8 +10,9 @@ import (
 )
 
 type SandboxEvent struct {
-	Version string `ch:"version"`
-	Type    string `ch:"type"`
+	ID      uuid.UUID `ch:"id"`
+	Version string    `ch:"version"`
+	Type    string    `ch:"type"`
 
 	EventCategory string         `ch:"event_category"`
 	EventLabel    string         `ch:"event_label"`
@@ -51,7 +52,8 @@ SELECT
     event_label,
     event_data,
     type,
-    version
+    version,
+    id
 FROM sandbox_events
 WHERE sandbox_id = ?
 ORDER BY timestamp %s
@@ -96,7 +98,8 @@ SELECT
     event_label,
     event_data,
     type,
-    version
+    version,
+    id
 FROM sandbox_events
 WHERE sandbox_team_id = ?
 ORDER BY timestamp %s

packages/clickhouse/pkg/sandbox_events.go

@@ -127,8 +127,9 @@ func (es *SandboxEventsService) handleClickhouseBatcherEvent(ctx context.Context
 
 	if sandboxLifeCycleEventsWriteFlag {
 		err := es.batcher.Push(clickhouse.SandboxEvent{
-			Type:      event.Type,
 			Version:   event.Version,
+			ID:        event.ID,
+			Type:      event.Type,
 			Timestamp: event.Timestamp,
 
 			EventCategory: event.EventCategory,

packages/orchestrator/internal/events/sandbox_events_service.go

@@ -168,13 +168,15 @@ func (s *Server) Create(ctx context.Context, req *orchestrator.SandboxCreateRequ
 
 	teamID, buildId, eventData := s.prepareSandboxEventData(sbx)
 	go s.sbxEventsService.HandleEvent(context.WithoutCancel(ctx), events.SandboxEvent{
-		Version:       events.StructureVersionV2,
+		Version:   events.StructureVersionV2,
+		ID:        uuid.New(),
+		Type:      eventType.Type,
+		Timestamp: time.Now().UTC(),
+
 		EventCategory: eventType.LegacyCategory,
 		EventLabel:    eventType.LegacyLabel,
-		Type:          eventType.Type,
 		EventData:     eventData,
 
-		Timestamp:          time.Now().UTC(),
 		SandboxID:          sbx.Runtime.SandboxID,
 		SandboxExecutionID: sbx.Runtime.ExecutionID,
 		SandboxTemplateID:  sbx.Config.BaseTemplateID,
@@ -210,13 +212,15 @@ func (s *Server) Update(ctx context.Context, req *orchestrator.SandboxUpdateRequ
 	eventType := events.SandboxUpdatedEventPair
 
 	go s.sbxEventsService.HandleEvent(context.WithoutCancel(ctx), events.SandboxEvent{
-		Version:       events.StructureVersionV2,
+		Version:   events.StructureVersionV2,
+		ID:        uuid.New(),
+		Type:      eventType.Type,
+		Timestamp: time.Now().UTC(),
+
 		EventCategory: eventType.LegacyCategory,
 		EventLabel:    eventType.LegacyLabel,
-		Type:          eventType.Type,
 		EventData:     eventData,
 
-		Timestamp:          time.Now().UTC(),
 		SandboxID:          sbx.Runtime.SandboxID,
 		SandboxExecutionID: sbx.Runtime.ExecutionID,
 		SandboxTemplateID:  sbx.Config.BaseTemplateID,
@@ -299,13 +303,15 @@ func (s *Server) Delete(ctxConn context.Context, in *orchestrator.SandboxDeleteR
 
 	eventType := events.SandboxKilledEventPair
 	go s.sbxEventsService.HandleEvent(context.WithoutCancel(ctx), events.SandboxEvent{
-		Version:       events.StructureVersionV2,
+		Version:   events.StructureVersionV2,
+		ID:        uuid.New(),
+		Type:      eventType.Type,
+		Timestamp: time.Now().UTC(),
+
 		EventCategory: eventType.LegacyCategory,
 		EventLabel:    eventType.LegacyLabel,
-		Type:          eventType.Type,
 		EventData:     eventData,
 
-		Timestamp:          time.Now().UTC(),
 		SandboxID:          sbx.Runtime.SandboxID,
 		SandboxExecutionID: sbx.Runtime.ExecutionID,
 		SandboxTemplateID:  sbx.Config.BaseTemplateID,
@@ -409,13 +415,15 @@ func (s *Server) Pause(ctx context.Context, in *orchestrator.SandboxPauseRequest
 
 	eventType := events.SandboxPausedEventPair
 	go s.sbxEventsService.HandleEvent(context.WithoutCancel(ctx), events.SandboxEvent{
-		Version:       events.StructureVersionV2,
+		Version:   events.StructureVersionV2,
+		ID:        uuid.New(),
+		Type:      eventType.Type,
+		Timestamp: time.Now().UTC(),
+
 		EventCategory: eventType.LegacyCategory,
 		EventLabel:    eventType.LegacyLabel,
-		Type:          eventType.Type,
 		EventData:     eventData,
 
-		Timestamp:          time.Now().UTC(),
 		SandboxID:          sbx.Runtime.SandboxID,
 		SandboxExecutionID: sbx.Runtime.ExecutionID,
 		SandboxTemplateID:  sbx.Config.BaseTemplateID,

packages/orchestrator/internal/server/sandboxes.go

@@ -28,8 +28,9 @@ var ValidSandboxEventTypes = []string{
 }
 
 type SandboxEvent struct {
-	Version string `json:"version"`
-	Type    string `json:"type"`
+	ID      uuid.UUID `json:"id"`
+	Version string    `json:"version"`
+	Type    string    `json:"type"`
 
 	// Deprecated: for new events use event field with dot syntax
 	EventCategory string `json:"event_category"`