Optimize can send essential data to production ET

Confluence summary on Optimize Telemetry: https://confluence.camunda.com/display/CO/Optimize+Telemetry

We want to understand how many active Camunda Optimize projects are in use, and in what kind of technical environment they are used in so that we can make informed strategic decisions on how to improve the stability and performance of our products.

Background

Currently, we do not know how many active Camunda Optimize projects are in use, and in what kind of technical environment they are used in.

We consider this to be essential telemetry as this information is crucial for us to further improve the stability and performance of our products, troubleshoot customer issues, increase customer success, and to make strategic decisions on how to best support our users in running successful Camunda projects.

Goals

In the first iteration we have following main goals:

• find out how many installations of Optimize and in which versions are out there
• find out which customers are having Optimize installed
• find out how many trial installations are out there 
• find out how many engines are usually connected to an Optimize installation

In later iterations we have additional goals, like:

• find out how many reports, dashboards, collections and alerts are being created
• find out how many users on average are using Optimize
• understand usage of specific features (like e.g. event based processes)

AC

As PM/Engineer/Marketing, I can see

• how many Camunda Optimize projects[product versions] are active.
  • Optimize version
  • flag if production or not (Possibility for future interations. Currently, we have no way of knowing this.)

• in what technical environment they are used in
  • JDK/JRE version (optional: vendor) [could be second iteration]
  • Elasticsearch version [could be second iteration]
  • Docker (running on Docker, if possible) [could be second iteration]

• the connected engine installation ids
• setup / config information
  • information about cluster settings (amount of Optimize nodes - if possible) [could be second iteration]
  • plugins used [could be second iteration]

This information can be grouped by

• customer name (based on license key) to support our customers adopting Camunda projects successfully.
• Installation IDs (generated once and stored in the database, so that every subsequent telemetry call using that databases reuses the ID)
• timeframes (days, weeks, months..) (this does not need to be submitted by the client)

Datapoints first iteration:

• Optimize version
• Optimize production flag
• License Key (incl. Customer Name or trial name)
• unique Installation ID
• Connected Engines Installation IDs (possibly depends on engine telemetry authorization config?)
• Elasticsearch version

Hints:

• Telemetry is disabled per default
• Telemetry can be activated via configuration
• There is a github project for internal E.T. services from Shared Service Team
• CAM-11952 has implemented very similar functionality that is shipped with 7.14, too. (as OPT 3.2)
• We probably need to track all data points that we are sending via telemetry so that we can add it to data privacy documents: For this to happen we need to send in the data points we are collecting using a Google Forms, the details can be found here: https://confluence.camunda.com/pages/viewpage.action?pageId=70787085, Felix did it already for the datapoints of first iteration that are mentioned above.

Out of scope:

OPT-4022: Advanced usage information (e.g. number of entities created, features being used, frequency of dashboard refresh or open, usage of specific features like sharing, alerting, etc)