Telemetry

You can opt in for the collection of telemetry data when using Desktop Modeler. This data is used to better understand how the application is used and to improve it based on data. This page summarizes the data collected.

General structure of the events

The events Desktop Modeler sends share a similar payload which usually (but not exclusively) includes information like:

• event name: The name of the event triggered (e.g. diagram:opened)
• application version: The version of Desktop Modeler being used (e.g. Version 5.0.0)
• editor id: A randomly generated id assigned to your Desktop Modeler installation

Definition of events

Ping event

The Ping Event is sent in the following situations:

• The modeler is opened (given that Usage Statistics option is enabled).
• Usage Statistics option is enabled for the first time.
• Once every 24 hours (given that Usage Statistics option is enabled).

The Ping Event also sends the list of plugins installed and flags defined:

  "plugins": ["PLUGIN_NAME"],
  "flags": {
    "FLAG_NAME": "FLAG_VALUE"
  }

Diagram opened/closed event

The Diagram Opened Event is sent in the following situations:

• User created a new BPMN diagram
• User created a new DMN diagram
• User created a new Form
• User opened an existing BPMN diagram
• User opened an existing DMN diagram
• User opened an existing Form

The Diagram Closed Event is sent in the following situations:

• User closed a BPMN diagram
• User closed a DMN diagram
• User closed a Form

These events include the following properties:

• diagramType: BPMN, DMN, or Form
• Engine profile:
  • executionPlatform: <target platform>
  • executionPlatformVersion: <target platform version>

In the case of a form, the payload also includes the formFieldTypes:

"formFieldTypes": {
  "textfield": 6,
  "group": 2,
  "image": 4
}

Deployment and start instance events

The Deployment Event is sent in the following situations:

• User deploys a BPMN or DMN diagram to Camunda 7 or Camunda 8
• User deploys a Form to Camunda 7

The Deployment Event and Start Instance have the following properties:

• diagramType: BPMN, DMN, or Form
• Engine profile:
  • executionPlatform: <target platform>
  • executionPlatformVersion: <target platform version>

In the event of an unsuccessful deployment, an error property will be present in the payload containing an error code.

If provided, as is the case when deploying to a Zeebe-based platform, the payload also includes the target type of the deployment:

"targetType": "[camundaCloud or selfHosted]"

If the target engine profile is set in the diagram, the payload will also contain it.

 "executionPlatform": "<target platform>"

Tracked click events

The Tracked Click Events are sent when a user clicks a link or button contained within a tracked parent 'container'.

Currently, these containers are:

• Each of the welcome page columns
• The version info overlay

The event supplies:

• The parent container id to locate the application section
• The button label or link text (generalized as label) for identification of what was specifically clicked
• A type to differentiate buttons, internal links, and external links
• The link target (optional for external links)

Example event:

{
  "type": "[button or external-link or internal-link]",
  "parent": "welcome-page-learn-more",
  "label": "Click here to read more about Camunda",
  "link": "https://camunda.com/"
}

note

"link" is only present for "type": "external-link".

Overlay opened event

The Overlay Opened Event is sent when an overlay is opened via user interaction. Currently, this event is sent in the following circumstances:

• Version Info overlay is opened
• Deployment overlay is opened
• Start instance overlay is opened
• Deployment overlay is closed
• Start Instance overlay is closed

For the Version Info overlay, the event also sends source of the click ("menu" or "statusBar").

For the Deployment and Start Instance overlays, the event also send the diagramType (BPMN, DMN or Form).

Form editor events

The Form editor events are sent on different interactions with the form builder:

• User opened or collapsed a panel in the form editor. The event includes the current open state for each form preview panel and the interaction that triggered the change.

{
  "layout": {
    "form-input": {
      "open": true
    },
    "form-output": {
      "open": true
    },
    "form-preview": {
      "open": true
    }
  },
  "triggeredBy": "keyboardShortcut|previewPanel|statusBar|windowMenu"
}

• User interacted with the form input data panel.
• User interacted with the form preview panel.

In all events the execution platform and version are sent as well.

BPMN editor events

BPMN editor events are sent on different interactions with the BPMN editor:

• User created, appended, or replaced an element on the canvas. These events include the oldElement/sourceElement (when applicable) and the new element(s).
• User selected, updated, unlinked, or removed an element template from an element via the properties panel. These events include the current diagram selection and respective element templates.
• User interacted with the pop-up menu, context menu, or the palette. These events include the target (entryId, entryGroup, entryTitle) and triggerType ("click", "drag", or "keyboard") of the interaction, as well as the current diagram selection.

Example event:

{
  "entryId": "create.start-event",
  "entryGroup": "event",
  "entryTitle": "Start Event",
  "selection": [
    {
      "id": "StartEvent_1",
      "type": "bpmn:StartEvent",
      "templateId": "template-start-event"
    }
  ],
  "triggerType": "keyboard"
}