🔭 emit template creation events (cyclops-ui#533)

* emit template creation events

* disable telemetry in dev

* ⚙️ update cyclops to v0.10.0-rc-telemetry

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: petar-cvit

.github/workflows/ci.yml

@@ -86,6 +86,8 @@ jobs:
         with:
           context: "{{defaultContext}}:cyclops-ctrl"
           platforms: linux/amd64,linux/arm64
+          build-args: |
+            VERSION=${{ github.event.inputs.version }}
           push: true
           tags: cyclopsui/cyclops-ctrl:${{ github.event.inputs.version }}
 

cyclops-ctrl/.env

@@ -1,3 +1,4 @@
 DISABLE_TELEMETRY=true
 PORT=8888
-WATCH_NAMESPACE=cyclops
+WATCH_NAMESPACE=cyclops
+CYCLOPS_VERSION=v0.0.0

cyclops-ctrl/Dockerfile

@@ -13,6 +13,9 @@ RUN go build -o /build/bin ./...
 
 FROM alpine:3.20.0
 
+ARG VERSION
+ENV CYCLOPS_VERSION=$VERSION
+
 WORKDIR /app
 
 RUN mkdir /app/bin

cyclops-ctrl/cmd/main/main.go

@@ -63,7 +63,11 @@ func main() {
 
 	setupLog.Info("starting handler")
 
-	telemetryClient, _ := telemetry.NewClient(getEnvBool("DISABLE_TELEMETRY"), setupLog)
+	telemetryClient, _ := telemetry.NewClient(
+		getEnvBool("DISABLE_TELEMETRY"),
+		os.Getenv("CYCLOPS_VERSION"),
+		setupLog,
+	)
 	telemetryClient.InstanceStart()
 
 	k8sClient, err := k8sclient.New()

cyclops-ctrl/internal/controller/templates.go

@@ -12,21 +12,25 @@ import (
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/cluster/k8sclient"
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/mapper"
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/models/dto"
+	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/telemetry"
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/template"
 )
 
 type Templates struct {
 	templatesRepo    *template.Repo
 	kubernetesClient *k8sclient.KubernetesClient
+	telemetryClient  telemetry.Client
 }
 
 func NewTemplatesController(
 	templatesRepo *template.Repo,
 	kubernetes *k8sclient.KubernetesClient,
+	telemetryClient telemetry.Client,
 ) *Templates {
 	return &Templates{
 		templatesRepo:    templatesRepo,
 		kubernetesClient: kubernetes,
+		telemetryClient:  telemetryClient,
 	}
 }
 
@@ -136,6 +140,8 @@ func (c *Templates) CreateTemplatesStore(ctx *gin.Context) {
 
 	k8sTemplateStore := mapper.DTOToTemplateStore(*templateStore, tmpl.IconURL)
 
+	c.telemetryClient.TemplateCreation()
+
 	if err := c.kubernetesClient.CreateTemplateStore(k8sTemplateStore); err != nil {
 		ctx.JSON(http.StatusInternalServerError, dto.NewError("Error creating module", err.Error()))
 		return
@@ -174,6 +180,8 @@ func (c *Templates) EditTemplatesStore(ctx *gin.Context) {
 
 	k8sTemplateStore := mapper.DTOToTemplateStore(*templateStore, tmpl.IconURL)
 
+	c.telemetryClient.TemplateEdit()
+
 	if err := c.kubernetesClient.UpdateTemplateStore(k8sTemplateStore); err != nil {
 		ctx.JSON(http.StatusInternalServerError, dto.NewError("Error creating module", err.Error()))
 		return

cyclops-ctrl/internal/handler/handler.go

@@ -44,7 +44,7 @@ func New(
 func (h *Handler) Start() error {
 	gin.SetMode(gin.DebugMode)
 
-	templatesController := controller.NewTemplatesController(h.templatesRepo, h.k8sClient)
+	templatesController := controller.NewTemplatesController(h.templatesRepo, h.k8sClient, h.telemetryClient)
 	modulesController := controller.NewModulesController(h.templatesRepo, h.k8sClient, h.renderer, h.telemetryClient, h.monitor)
 	clusterController := controller.NewClusterController(h.k8sClient)
 

cyclops-ctrl/internal/telemetry/client.go

@@ -9,6 +9,8 @@ type Client interface {
 	ModuleCreation()
 	ModuleReconciliation()
 	InstanceStart()
+	TemplateCreation()
+	TemplateEdit()
 }
 
 type logger interface {
@@ -19,11 +21,12 @@ type logger interface {
 type EnqueueClient struct {
 	client     posthog.Client
 	distinctID string
+	version    string
 }
 
 type MockClient struct{}
 
-func NewClient(disable bool, logger logger) (Client, error) {
+func NewClient(disable bool, version string, logger logger) (Client, error) {
 	if disable {
 		logger.Info("telemetry disabled")
 		return MockClient{}, nil
@@ -53,30 +56,62 @@ func NewClient(disable bool, logger logger) (Client, error) {
 	return EnqueueClient{
 		client:     client,
 		distinctID: idStr,
+		version:    version,
 	}, nil
 }
 
 func (c EnqueueClient) InstanceStart() {
 	_ = c.client.Enqueue(posthog.Capture{
 		Event:      "cyclops-instance-start",
 		DistinctId: c.distinctID,
+		Properties: map[string]interface{}{
+			"version": c.version,
+		},
 	})
 }
 
 func (c EnqueueClient) ModuleReconciliation() {
 	_ = c.client.Enqueue(posthog.Capture{
 		Event:      "module-reconciliation",
 		DistinctId: c.distinctID,
+		Properties: map[string]interface{}{
+			"version": c.version,
+		},
 	})
 }
 
 func (c EnqueueClient) ModuleCreation() {
 	_ = c.client.Enqueue(posthog.Capture{
 		Event:      "module-creation",
 		DistinctId: c.distinctID,
+		Properties: map[string]interface{}{
+			"version": c.version,
+		},
+	})
+}
+
+func (c EnqueueClient) TemplateCreation() {
+	_ = c.client.Enqueue(posthog.Capture{
+		Event:      "template-creation",
+		DistinctId: c.distinctID,
+		Properties: map[string]interface{}{
+			"version": c.version,
+		},
 	})
 }
 
+func (c EnqueueClient) TemplateEdit() {
+	_ = c.client.Enqueue(posthog.Capture{
+		Event:      "template-edit",
+		DistinctId: c.distinctID,
+		Properties: map[string]interface{}{
+			"version": c.version,
+		},
+	})
+}
+
+// region mock client
+
 func (c MockClient) InstanceStart() {
 }
 
@@ -85,3 +120,9 @@ func (c MockClient) ModuleReconciliation() {
 
 func (c MockClient) ModuleCreation() {
 }
+
+func (c MockClient) TemplateCreation() {}
+
+func (c MockClient) TemplateEdit() {}
+
+// endregion

install/cyclops-install.yaml

@@ -334,7 +334,7 @@ spec:
     spec:
       containers:
         - name: cyclops-ui
-          image: cyclopsui/cyclops-ui:v0.9.1
+          image: cyclopsui/cyclops-ui:v0.10.0-rc-telemetry
           ports:
             - containerPort: 80
           env:
@@ -397,7 +397,7 @@ spec:
       serviceAccountName: cyclops-ctrl
       containers:
         - name: cyclops-ctrl
-          image: cyclopsui/cyclops-ctrl:v0.9.1
+          image: cyclopsui/cyclops-ctrl:v0.10.0-rc-telemetry
           ports:
             - containerPort: 8080
           env:

web/docs/usage_metrics/usage_metrics.md

@@ -6,7 +6,10 @@ These events include:
 
 **- `cyclops-instance-start`** - triggered once at the start of cyclops-ctrl pod  
 **- `module-creation`** - called by the UI each time you create a new module  
-**- `module-reconciliation`** - each time a Module CRD in the cluster is changed
+**- `module-reconciliation`** - each time a Module CRD in the cluster is changed  
+**- `template-creation`** - called each time a template is added in the `Templates` tab  
+**- `template-edit`** - called each time a template is edited in the `Templates` tab
+
 
 The metric collection is implemented using [posthog](https://posthog.com).
 
@@ -17,12 +20,16 @@ Each time one of the events above is triggered, Cyclops sends an HTTP request to
   "type": "capture",
   "timestamp": "2024-03-23T19:05:38.808279+01:00",
   "distinct_id": "f46d57f0-e93f-11ee-924c-8281c5d92ae4",
-  "event": "cyclops-instance-start"
+  "event": "cyclops-instance-start",
+  "properties": {
+    "version": "v0.10.0"
+  }
 }
 ```
 
 `distinct_id` - generated for each Cyclops instance using [NewUUID](https://pkg.go.dev/github.com/google/uuid#NewUUID) from google/uuid package  
-`event` - which event was triggered; see events above
+`event` - which event was triggered; see events above  
+`properties.version` - version of your Cyclops instance
 
 ## Turn off