Add data collection page

docs/reference/data-collection/data-collection.md

@@ -0,0 +1,119 @@
+---
+id: data-collection
+title: "Data collection"
+description: "Learn about the data collected by Camunda."
+---
+
+import AnalyticsImg from './../img/analytics.png';
+import CookiePrefsImg from './../img/cookie-preferences.png';
+
+Camunda collects a variety of telemetry data to evaluate contractual usage, provide a better user experience, and improve its products. This section describes which telemetry data is collected, how Camunda ensures privacy, and what options you have to modify which telemetry data is sent to Camunda. This document is designed to help you understand what telemetry data includes and excludes and applies only to interactions with Camunda's products. This document will be updated from time to time.
+
+## Purposes
+
+Camunda collects certain types of data we call “telemetry data” for the purposes described below:
+
+- for billing,
+- to improve the user experience, to track and analyze usage of the Software,
+- to ensure the security, stability, and functionality of the Software, or
+- to provide support to Customers, such as guidance that will help optimize usage regarding the product and new functionalities.
+
+## Principles
+
+Camunda follows certain principles in its collection and use of telemetry data to ensure the privacy of its customers and the success of its product development efforts:
+
+- Camunda will use telemetry data subject to applicable law (including opt-in and opt-out functionalities for personal data where necessary).
+  Telemetry data is generally aggregated unless users opt-in for personalized use of their telemetry data (for example, to provide additional support or optimize product usage to customers).
+- Telemetry data does not include any data shared in process instances or uploaded in customer clusters. Therefore, **no end-user or end-customer personal data**, personal information (PII), or protected health information (PHI) uploaded to a customer cluster is part of telemetry data.
+- Telemetry data does **not include payment information**.
+- Camunda does **not sell any personal (user) information.**
+- **For Self-Managed customers, telemetry data is always fully anonymous and only sent upon admin/owner enablement from the customer.**
+- Data collected from end-users such as form fills or process variables are not part of telemetry data. For example, if part of your process involves a user filling in a shipping address, that address is not telemetry data.
+- Assets like the BPMN diagram describing how a process is defined and executed are not telemetry data. Telemetry data does not include information about how customers develop their processes, like keystrokes or BPMN diagrams. Instead, it includes user-provided identifiers like a process ID to track which Camunda software features are used when developing a process.
+- Customers are responsible for avoiding sharing intellectual property, personal data or sensitive data through interaction with AI features. The data collected by different AI features is shared [below](#usage-telemetry-data-saas-and-desktop-modeler-only).
+- Camunda will not use telemetry data in any way that identifies the source of the telemetry data to third parties except as necessary for Camunda to enforce its rights and contractual obligations, such as charging fees for overage of usage metrics or complying with a lawful subpoena.
+
+## Telemetry data collection
+
+Telemetry data includes contractual metrics, environment, and usage data. Telemetry data is collected automatically in SaaS (except for personalized telemetry data which is only used via user discretionary opt-in) and collected via admin discretionary opt-in for Self-Managed platforms. Each category of telemetry data is described below.
+
+### Contractual metrics telemetry data
+
+Contractual metrics telemetry data includes a limited set of contractually agreed [usage metrics](/reference/data-collection/usage-metrics.md) to evaluate usage metric use and bill for overages. One example is how many process instance usage metrics are used compared to the number of process instance usage metrics purchased by customers. These are summary usage metrics that contain no sensitive information and that are collected automatically for SaaS customers and sent in a report generated by Self-Managed customers.
+
+### Environment telemetry data (Self-Managed only)
+
+Environment telemetry data includes information about your Self-Managed installations to enable better support and product improvement decisions. Self-Managed customers may choose to send a very limited set of environment information through the Console component's telemetry mechanism. View the [telemetry](/self-managed/console-deployment/telemetry.md) page for a description of this data. Environment telemetry data is not relevant to SaaS installations.
+
+### Usage telemetry data (SaaS and Desktop Modeler only)
+
+Usage telemetry data includes limited product usage data to help make better product improvement decisions and enable outreach to support users. This section describes the types of data and how they are collected.
+
+- Feature Usage:
+
+  - SaaS System Actions: All SaaS organizations submit basic information about which features are being used as part of telemetry data collection. When certain features are used, Camunda logs which feature is used and basic information about how it has been used. This information is tied to a pseudonymized organization.
+  - SaaS User Actions: Users that opt-in to analytics cookies gain access to in-app tutorials and automatically submit information about which features they interact with in Camunda’s UI as part of telemetry data. In addition to the data collected from system actions described above, Camunda collects cursor activity, geographical area, browser information, and basic biographical information limited to email, name, and city/region/country for user actions. If a user interacts through API, then personal information is not collected.
+
+  <img src={CookiePrefsImg} alt="Cookie preferences in user settings" width="300px" style={{border: 'none', padding: '0', marginTop: '0', backgroundColor: 'transparent'}}/>
+  <img src={AnalyticsImg} alt="Analytics opt-in menu" width="500px" style={{border: 'none', padding: '0', marginTop: '0', backgroundColor: 'transparent'}}/>
+
+  - Desktop Modeler User Actions: Users opting into collection of telemetry data in [Desktop Modeler](/components/modeler/desktop-modeler/telemetry/telemetry.md) send data to Camunda when to track how certain features are used, as described in the linked document.
+
+- AI Usage: Camunda's AI features, currently available in SaaS only, are clearly labeled as AI features. For Enterprise organizations, these features must be enabled by the customer via opt-in in the [Console](/components/console/manage-organization/enable-alpha-features.md#enable-ai-powered-features). Depending on the feature, they may collect different information.
+  - Camunda [Docs AI](/components/modeler/web-modeler/advanced-modeling/camunda-docs-ai.md) records the entire conversation to provide ongoing support.
+  - Camunda [Copilots](/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md) only gather usage telemetry data. Camunda automatically logs all information sent to and from our AI models for system monitoring by a limited set of operators. Camunda will only use the data from free users for product and model improvement.
+
+### Example
+
+Below is an example of user action data collected by the platform:
+
+```json
+{
+  "event": "modeler:deploy:confirm",
+  "properties": {
+    "time": 1721228056.002,
+    "distinct_id": "auth0|669533a8339ceebe5e8f7fed",
+    "$browser": "Microsoft Edge",
+    "$browser_version": 126,
+    "$city": "Gotham City",
+    "$current_url": "https://modeler.camunda.io/diagrams/a8c077ae-22d6-4be3-bebb-a847f40376fe--batsymbol-activate?v=736,217,1",
+    "$device_id": "190b6d254651ec-0a7e1ef548a163-4c657b58-e1000-190b6d2518f1ec",
+    "$initial_referrer": "https://console.camunda.io/",
+    "$initial_referring_domain": "console.camunda.io",
+    "$insert_id": "xjsmufevamu6v5y7",
+    "$lib_version": "2.53.0",
+    "$mp_api_endpoint": "api-js.mixpanel.com",
+    "$mp_api_timestamp_ms": 1721228056805,
+    "$os": "Windows",
+    "$referrer": "https://dsm-1.operate.camunda.io/",
+    "$referring_domain": "dsm-1.operate.camunda.io",
+    "$region": "New Jersey",
+    "$screen_height": 1080,
+    "$screen_width": 1920,
+    "$user_id": "auth0|669533a8339ceebe5e8f7fed",
+    "clusterId": "ea9ddef9-f1e3-4241-a37c-655334c45de8",
+    "clusterTag": "dev",
+    "clusterVersion": "8.5",
+    "connectors": ["io.camunda.connectors.HttpJson.v2"],
+    "containsUserTasks": true,
+    "deployType": "single-file",
+    "deployedForms": {
+      "Form_0ec4ghh": "764a75e7-85a8-448f-8a1f-4952cc8a189d"
+    },
+    "fileId": "a8c077ae-22d6-4be3-bebb-af97040123fe",
+    "fileType": "bpmn",
+    "license": "Free",
+    "mp_country_code": "US",
+    "mp_lib": "web",
+    "mp_processing_time_ms": 1721228056937,
+    "mp_sent_by_lib_version": "2.53.0",
+    "orgId": "30ba73a-4b2f-433f-80e5-d41176874bb5",
+    "org_id": "30ba73a-4b2f-433f-80e5-d41176874bb5",
+    "organizationId": "30ba73a-4b2f-433f-80e5-d41176874bb5",
+    "stage": "prod",
+    "success": true,
+    "userId": "auth0|669533a8339ceebe5e8f7fed",
+    "version": "8.5.4"
+  }
+}
+```

docs/reference/overview.md

@@ -29,5 +29,5 @@ Learn about the [Camunda release policy](release-policy.md) with some specific c
 ## Additional resources
 
 - [Regions](regions.md) - When you create a cluster in Camunda 8 SaaS, specify a region for that cluster.
-- [Usage metrics](usage-metrics.md) - Understand the three main usage metrics that have an impact on Camunda 8 pricing.
+- [Usage metrics](/reference/data-collection/usage-metrics.md) - Understand the three main usage metrics that have an impact on Camunda 8 pricing.
 - [Glossary](glossary.md) - Have a closer look at common terminology used across Camunda 8 documentation.

sidebars.js

@@ -953,7 +953,15 @@ module.exports = {
     "reference/notices",
     "reference/release-policy",
     "reference/regions",
-    "reference/usage-metrics",
+    {
+      type: "category",
+      label: "Data collection",
+      link: {
+        type: "doc",
+        id: "reference/data-collection/data-collection",
+      },
+      items: ["reference/data-collection/usage-metrics"],
+    },
     "reference/glossary",
   ],
   "Self-Managed": [

static/.htaccess

@@ -500,4 +500,5 @@ RewriteRule ^docs/components/modeler/web-modeler/save-and-deploy/?$ /docs/compon
 RewriteRule ^docs/next/components/modeler/web-modeler/start-instance/?$ /docs/next/components/modeler/web-modeler/run-or-publish-your-process/ [R=301,L]
 RewriteRule ^docs/next/components/modeler/web-modeler/save-and-deploy/?$ /docs/next/components/modeler/web-modeler/run-or-publish-your-process/#deploy-a-process [R=301,L,NE]
 
-
+# Move user metrics page to a new folder
+RewriteRule ^docs/reference/usage-metrics.md/?$ ^docs/reference/data-collection/usage-metrics.md/? [R=301,L,NE]