Implement MVP for tracking user-flow analysis with Mixpanel

What should we do?

Implement tracking for user-flow analysis with Mixpanel. This means tracking application-scoped events like diagramOpened, diagramClosed, deployOpened, …

• Define base properties to include in events’ payload:
  • distinctId: editorID
  • version
  • (if applicable) executionPlatform
  • (if applicable) executionPlatformVersion
  • stage: [int, dev, prod]
• Define events to emit:

Event	Properties
diagram:opened	diagramType: [bpmn, dmn, form]
diagram:closed	diagramType: [bpmn, dmn, form]
overlay:deployment:opened	diagramType: [bpmn, dmn, form]
overlay:deployment:closed	diagramType: [bpmn, dmn, form]
deployment:success	diagramType: [bpmn, dmn, form] targetType: [selfHosted, camundaCloud]
deployment:error	diagramType: [bpmn, dmn, form] targetType: [selfHosted, camundaCloud] error
overlay:startInstance:opened	diagramType: [bpmn, dmn, form]
overlay:startInstance:closed	diagramType: [bpmn, dmn, form]
startInstance:success	diagramType: [bpmn, dmn, form] targetType: [selfHosted, camundaCloud]
startInstance:error	diagramType: [bpmn, dmn, form] targetType: [selfHosted, camundaCloud] error
overlay:versionInfo:opened	source: [menu or statusBar]
link:opened	link
button:clicked	label

• Integrate this in the Modeler using the prototype developed here
  • Set stage to int in “nightly” versions
  • Add tab events (diagram:opened and tab:closed) - https://github.com/camunda/camunda-modeler/pull/2941
  • Add deploy/startInstance events - https://github.com/camunda/camunda-modeler/pull/2986
  • Add overlay events - https://github.com/camunda/camunda-modeler/pull/2941
  • Add link/button events - https://github.com/camunda/camunda-modeler/pull/2981
• Add project token as secret in Github repo

Why should we do it?

This allows us to do user flow-analysis and see all telemetry data in a central place. (e.g., combine Web Modeler and Desktop Modeler data). See https://github.com/bpmn-io/internal-docs/issues/504 for more.

Child of https://github.com/bpmn-io/internal-docs/issues/504

[smbea]

Yes, int makes sense. My main point: separate these from the prod events

[christian-konrad]

I also suggest to name startInstance:opened to startInstancePanel:opened or panel:startInstance:opened or similar, same for deployment, to be less ambiquous (startInstance could also be the action itself)

And in general, is it “link:clicked” or “link:followed”? (In case the link is opened via keyboard… should it be named by the action or the outcome? Does Mixpanel have any best practices?)