Add data collection page #4846
+437
−7
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,112 @@ | ||||||
| --- | ||||||
| id: data-collection | ||||||
| title: "Data collection" | ||||||
| description: "Learn about the data collected by Camunda." | ||||||
| --- | ||||||
|
|
||||||
| 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, where necessary, opt-in and opt-out functionalities for personal data). | ||||||
| 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. Contractual metrics, environment, and usage telemetry data are collected automatically in SaaS (except for personalized telemetry data which is only used via user discretionary opt-in) or collected via admin discretionary opt-in for Self-Managed platforms. Each of these categories of telemetry data are described below. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### Contractual metrics telemetry | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 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. For example, 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. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### 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. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### 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 tolike email, and name, and city/region/country for user actions. If a user interacts through API, then personal information is not collected. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - 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. For free users only, Copilots may collect all information sent to and from our AI models for product and model improvement. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### 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" | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| --- | ||
| id: data-collection | ||
| title: "Data collection" | ||
| description: "Learn about the data collected by Camunda." | ||
| --- | ||
|
|
||
| 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, where necessary, opt-in and opt-out functionalities for personal data). | ||
| 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. Contractual metrics, environment, and usage telemetry data are collected automatically in SaaS (except for personalized telemetry data which is only used via user discretionary opt-in) or collected via admin discretionary opt-in for Self-Managed platforms. Each of these categories of telemetry data are described below. | ||
|
|
||
| ### Contractual metrics telemetry | ||
|
|
||
| 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. For example, 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](/components/modeler/desktop-modeler/telemetry/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 tolike email, and name, and city/region/country for user actions. If a user interacts through API, then personal information is not collected. | ||
| - 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. | ||
|
|
||
|
There was a problem hiding this comment. For the 8.6 version of this doc, I removed the section on Camunda Copilots, as those docs are only available in 8.7 and 8.8. If this is available in 8.6, I can either:
There was a problem hiding this comment. The Camunda Copilots are just now available on SaaS 8.6, which is currently rolled out to everyone. I'd keep 8.6 |
||
| ### 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" | ||
| } | ||
| } | ||
| ``` | ||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.