Merge branch '574-telemetry-events' into 'dle-4-0'

feat: add new telemetry events (#574)

See merge request postgres-ai/database-lab!957

Author: agneum

engine/internal/srv/branch.go

@@ -1,6 +1,7 @@
 package srv
 
 import (
+	"context"
 	"fmt"
 	"net/http"
 	"regexp"
@@ -13,6 +14,7 @@ import (
 	"gitlab.com/postgres-ai/database-lab/v3/internal/provision/resources"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/provision/thinclones"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/srv/api"
+	"gitlab.com/postgres-ai/database-lab/v3/internal/telemetry"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/webhooks"
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/client/dblabapi/types"
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/log"
@@ -247,6 +249,10 @@ func (s *Server) createBranch(w http.ResponseWriter, r *http.Request) {
 		EntityID:  branch.Name,
 	}
 
+	s.tm.SendEvent(context.Background(), telemetry.BranchCreatedEvent, telemetry.BranchCreated{
+		Name: branch.Name,
+	})
+
 	if err := api.WriteJSON(w, http.StatusOK, branch); err != nil {
 		api.SendError(w, r, err)
 		return
@@ -440,6 +446,8 @@ func (s *Server) snapshot(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	s.tm.SendEvent(context.Background(), telemetry.SnapshotCreatedEvent, telemetry.SnapshotCreated{})
+
 	if err := api.WriteJSON(w, http.StatusOK, types.SnapshotResponse{SnapshotID: targetSnap}); err != nil {
 		api.SendError(w, r, err)
 		return
@@ -643,6 +651,10 @@ func (s *Server) deleteBranch(w http.ResponseWriter, r *http.Request) {
 		EntityID:  deleteRequest.BranchName,
 	}
 
+	s.tm.SendEvent(context.Background(), telemetry.BranchDestroyedEvent, telemetry.BranchDestroyed{
+		Name: deleteRequest.BranchName,
+	})
+
 	if err := api.WriteJSON(w, http.StatusOK, models.Response{
 		Status:  models.ResponseOK,
 		Message: "Deleted branch",

engine/internal/srv/config.go

@@ -17,6 +17,7 @@ import (
 	"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/logical"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/tools/db"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/srv/api"
+	"gitlab.com/postgres-ai/database-lab/v3/internal/telemetry"
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/config"
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/log"
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/models"
@@ -78,6 +79,8 @@ func (s *Server) setProjectedAdminConfig(w http.ResponseWriter, r *http.Request)
 		return
 	}
 
+	s.tm.SendEvent(context.Background(), telemetry.ConfigUpdatedEvent, telemetry.ConfigUpdated{})
+
 	retrievalStatus := s.Retrieval.State.Status
 
 	if err := s.Retrieval.RemovePendingMarker(); err != nil {

engine/internal/srv/routes.go

@@ -516,6 +516,11 @@ func (s *Server) patchClone(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	s.tm.SendEvent(context.Background(), telemetry.CloneUpdatedEvent, telemetry.CloneUpdated{
+		ID:        util.HashID(cloneID),
+		Protected: patchClone.Protected,
+	})
+
 	if err := api.WriteJSON(w, http.StatusOK, updatedClone); err != nil {
 		api.SendError(w, r, err)
 		return

engine/internal/telemetry/events.go

@@ -49,11 +49,30 @@ type CloneCreated struct {
 	DSADiff     *float64 `json:"dsa_diff,omitempty"`
 }
 
+// CloneUpdated describes the clone updates.
+type CloneUpdated struct {
+	ID        string `json:"id"`
+	Protected bool   `json:"protected"`
+}
+
 // CloneDestroyed describes a clone destruction event.
 type CloneDestroyed struct {
 	ID string `json:"id"`
 }
 
+// BranchCreated describes a branch creation event.
+type BranchCreated struct {
+	Name string `json:"name"`
+}
+
+// BranchDestroyed describes a branch destruction event.
+type BranchDestroyed struct {
+	Name string `json:"name"`
+}
+
+// ConfigUpdated describes the config updates.
+type ConfigUpdated struct{}
+
 // Alert describes alert events.
 type Alert struct {
 	Level   models.AlertType `json:"level"`

engine/internal/telemetry/telemetry.go

@@ -29,9 +29,20 @@ const (
 	// CloneDestroyedEvent describes a clone destruction event.
 	CloneDestroyedEvent = "clone_destroyed"
 
+	// CloneUpdatedEvent describes a clone update event.
+	CloneUpdatedEvent = "clone_updated"
+
 	// SnapshotCreatedEvent describes a snapshot creation event.
 	SnapshotCreatedEvent = "snapshot_created"
 
+	// BranchCreatedEvent describes a branch creation event.
+	BranchCreatedEvent = "branch_created"
+
+	// BranchDestroyedEvent describes a branch destruction event.
+	BranchDestroyedEvent = "branch_destroyed"
+
+	ConfigUpdatedEvent = "config_updated"
+
 	// AlertEvent describes alert events.
 	AlertEvent = "alert"
 )