Add data collection page #4846

HanselIdes · 2025-01-14T13:53:38Z

Description

Resolves #4038
Blocked by

Provides an overview into the data collected by Camunda's products.

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
This is part of a scheduled alpha or minor. (apply alpha or minor label)
There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).
I included my new page in the sidebar file(s).
I added a redirect for a renamed or deleted page to the .htaccess file.
My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

github-actions · 2025-01-14T13:54:01Z

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

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

versioned_docs/version-8.3/reference/data-collection/data-collection.md

versioned_docs/version-8.4/reference/data-collection/data-collection.md

versioned_docs/version-8.5/reference/data-collection/data-collection.md

versioned_docs/version-8.6/reference/data-collection/data-collection.md

pepopowitz · 2025-01-14T16:26:45Z

Re: the build errors you're seeing, it looks like the links are incorrect in two ways:

The path should exclude docs/, because that will link to the "next" version regardless of which version the user is coming from.
The path should be the file path on your file system, not the path a user would see in their browser. It looks to me like you're missing a telemetry/ folder near the end of the link path.

I'm also going to assign tech writers for review, as they should be the reviewers for content changes like this.

conceptualshark

I've updated a few of the links that were throwing errors, but not entirely, as a few are within versions that do not have a matching page to link to - largely the SM Console telemetry links prior to 8.5, but also the "AI-powered features" section was introduced in 8.5 as well.

The remainder of the content looks good to me, but for versions 8.3 and 8.4, I am unsure if you'd like to remove the versioned references, or leave them and always point the reader to /next, where the page exists.

HanselIdes · 2025-02-07T12:58:01Z

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

+
+- Feature Usage:
+  - SaaS System Actions: All SaaS organizations submit basic information about which features are being used. 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 an pseudonymized organization.
+  - SaaS User Actions: Users that opt-in to analytics cookies


@conceptualshark can you please include screenshots of these 2 parts of the UI to explain how to opt-out of analytics cookies?

HanselIdes · 2025-02-12T10:56:08Z

Hi @conceptualshark or @pepopowitz , I'm strapped for time and I'd like to release these docs ideally by EOW. Can one of you support merging in the post-legal review changes here and push the docs live?

conceptualshark · 2025-02-12T14:23:55Z

@HanselIdes I can get this updated for you! To confirm from the conversation on Slack, I will also remove the backported versions of these updates? Should these changes be available in 8.6, 8.7, and 8.8? Thank you!

HanselIdes · 2025-02-12T15:25:55Z

@HanselIdes I can get this updated for you! To confirm from the conversation on Slack, I will also remove the backported versions of these updates? Should these changes be available in 8.6, 8.7, and 8.8?

Thanks @conceptualshark! That's a good call. These changes should be available in 8.6, 8.7, and 8.8

conceptualshark

@HanselIdes I still need to pull in the screenshots, but this should be updated with the new content, including removing the content from versions prior to 8.6, and introducing it for 8.7. I've flagged two specific changes here for you to look at as well.

docs/reference/overview.md

conceptualshark · 2025-02-12T18:15:01Z

versioned_docs/version-8.6/reference/data-collection/data-collection.md

+- Camunda [Docs AI](/components/modeler/web-modeler/advanced-modeling/camunda-docs-ai.md) records the entire conversation to provide ongoing support.
+


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:

Backport the Copilot docs to 8.6, and add it back in here

Link to the 8.7 or /next version of the Copilot docs here instead

The Camunda Copilots are just now available on SaaS 8.6, which is currently rolled out to everyone. I'd keep 8.6

HanselIdes · 2025-02-12T18:55:17Z

Hi @conceptualshark or @pepopowitz , I'm strapped for time and I'd like to release these docs ideally by EOW. Can one of you support merging in the post-legal review changes here and push the docs live?

Hi @conceptualshark the docs were basically completely re-written as part of the legal review. Can you use the link I shared above as the source of truth and copy over that content?

conceptualshark · 2025-02-12T19:03:18Z

This should include all the changes from the linked docs: f51aa19

Can you let me know if this is correct?

HanselIdes

@conceptualshark I reviewed the document closely for readability. I don't have any further changes requested from here

HanselIdes · 2025-02-13T08:13:49Z

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

+
+### 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.


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.

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.

HanselIdes · 2025-02-13T08:13:56Z

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

+
+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


Suggested change

### Contractual metrics telemetry

### Contractual metrics telemetry data

HanselIdes · 2025-02-13T08:14:47Z

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

+
+### 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.


Suggested change

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.

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.

HanselIdes · 2025-02-13T08:16:09Z

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

+
+## 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.


Suggested change

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.

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.

HanselIdes · 2025-02-13T08:16:41Z

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

+- 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.


Suggested change

- 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.

- 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.

HanselIdes · 2025-02-13T08:18:32Z

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

+
+- 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.


Suggested change

- 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.

- Camunda [Copilots](/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md) only gather usage telemetry data. Camunda automatically log 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.

HanselIdes · 2025-02-13T08:20:01Z

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

+
+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).


Suggested change

- Camunda will use telemetry data subject to applicable law (including, where necessary, opt-in and opt-out functionalities for personal data).

- Camunda will use telemetry data subject to applicable law (including opt-in and opt-out functionalities for personal data where necessary).

conceptualshark

@HanselIdes This should contain all of your edits, and the screenshots - if it feels complete to you, I think it could be pulled out of draft and another technical writer could give a final review. 😄

conceptualshark · 2025-02-13T14:52:12Z

versioned_docs/version-8.6/reference/data-collection/data-collection.md

+
+- 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](/docs/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.


@HanselIdes @akeller We have no concept of alpha features in the 8.6 documentation, so to add this back in, I've linked to the /next version of the docs here.

HanselIdes · 2025-02-14T12:21:44Z

@conceptualshark this looks good to me 👍🏼
from my perspective it's ready for the final tech writer reviews and approved. We still have to wait for the two tickets from @yT0n1 before this can be deployed to the docs env

conceptualshark · 2025-02-14T13:18:28Z

@HanselIdes I've approved, but put a Hold label on it so it isn't merged too early.

@camunda/tech-writers I've tagged you all for a quick check here! This document is approved by legal and so the wording can not be adjusted much, but as I did a lot of moving of content, a second set of eyes for spelling/grammar/etc would be great. I will also be out on Monday/Tuesday, so if this isn't merged today, any assistance there would be appreciated! 👍

github-actions · 2025-02-14T13:23:52Z

The preview environment relating to the commit 058c1e1 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4846/index.html

mesellings

Lgtm - I've reviewed it for spelling etc as you requested, and although I would like to change a lot of the wording, I understand it is legal so can't be touched, some formatting I might change, but nothing blocking so certainly good to go as a first iteration 👍 🚀

add data collection

d08e652

HanselIdes self-assigned this Jan 14, 2025

updated backport, .htaccess, sidebar

5b8565e

github-actions bot reviewed Jan 14, 2025

View reviewed changes

docs/reference/data-collection/data-collection.md Outdated Show resolved Hide resolved

docs/reference/data-collection/data-collection.md Outdated Show resolved Hide resolved

HanselIdes requested review from pepopowitz and ThuH2305 January 14, 2025 13:56

github-actions bot reviewed Jan 14, 2025

View reviewed changes

fix links

ea6e315

pepopowitz requested a review from a team January 14, 2025 16:26

fix links

44e10d7

conceptualshark reviewed Jan 15, 2025

View reviewed changes

HanselIdes commented Feb 7, 2025

View reviewed changes

conceptualshark added 7 commits February 12, 2025 12:31

remove data collection pre-8.6, move usage metrics pre-8.6

087d934

update versioned sidebars pre-8.6

add6aa7

update to new version of data collection docs

f51aa19

Merge branch 'main' into data-collection

6fc5c9a

update existing data collection docs, sidebars

5a963d2

add data collection to 8.7

842383e

update formatting, links

442a599

conceptualshark reviewed Feb 12, 2025

View reviewed changes

conceptualshark added deploy Stand up a temporary docs site with this PR available & undocumented This is already available but undocumented and should be released within a week. labels Feb 12, 2025

fix anchor link

c8b8957

fix console link

4d40f3c

github-actions bot temporarily deployed to camunda-docs February 12, 2025 19:16 Destroyed

update headings, usage data line

c0d0e70

github-actions bot temporarily deployed to camunda-docs February 12, 2025 19:59 Destroyed

HanselIdes commented Feb 13, 2025

View reviewed changes

add edit suggestions, fix link

ec68f80

github-actions bot temporarily deployed to camunda-docs February 13, 2025 14:31 Destroyed

conceptualshark added 2 commits February 13, 2025 09:44

add screenshots

0a993a0

add edits

4f8940b

conceptualshark reviewed Feb 13, 2025

View reviewed changes

github-actions bot temporarily deployed to camunda-docs February 13, 2025 14:58 Destroyed

HanselIdes marked this pull request as ready for review February 14, 2025 12:20

conceptualshark approved these changes Feb 14, 2025

View reviewed changes

conceptualshark added the hold This issue is parked, do not merge. label Feb 14, 2025

conceptualshark requested a review from a team February 14, 2025 13:16

github-actions bot temporarily deployed to camunda-docs February 14, 2025 13:19 Destroyed

mesellings self-requested a review February 14, 2025 15:26

mesellings approved these changes Feb 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add data collection page #4846

Add data collection page #4846

HanselIdes commented Jan 14, 2025 •

edited

Loading

github-actions bot commented Jan 14, 2025 •

edited

Loading

pepopowitz commented Jan 14, 2025

conceptualshark left a comment

HanselIdes Feb 7, 2025

HanselIdes commented Feb 12, 2025

conceptualshark commented Feb 12, 2025

HanselIdes commented Feb 12, 2025 •

edited

Loading

conceptualshark left a comment

conceptualshark Feb 12, 2025

HanselIdes Feb 12, 2025

HanselIdes commented Feb 12, 2025

conceptualshark commented Feb 12, 2025

HanselIdes left a comment

HanselIdes Feb 13, 2025

HanselIdes Feb 13, 2025

HanselIdes Feb 13, 2025

HanselIdes Feb 13, 2025

HanselIdes Feb 13, 2025

HanselIdes Feb 13, 2025

HanselIdes Feb 13, 2025

conceptualshark left a comment

conceptualshark Feb 13, 2025

HanselIdes commented Feb 14, 2025

conceptualshark commented Feb 14, 2025

github-actions bot commented Feb 14, 2025

mesellings left a comment

		- Camunda [Docs AI](/components/modeler/web-modeler/advanced-modeling/camunda-docs-ai.md) records the entire conversation to provide ongoing support.


		### 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.


		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

	### Contractual metrics telemetry
	### Contractual metrics telemetry data


		### 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.


		## 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.

	- 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.
	- Camunda [Copilots](/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md) only gather usage telemetry data. Camunda automatically log 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.


		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).

Add data collection page #4846

Are you sure you want to change the base?

Add data collection page #4846

Conversation

HanselIdes commented Jan 14, 2025 • edited Loading

Description

When should this change go live?

PR Checklist

github-actions bot commented Jan 14, 2025 • edited Loading

pepopowitz commented Jan 14, 2025

conceptualshark left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HanselIdes commented Feb 12, 2025

conceptualshark commented Feb 12, 2025

HanselIdes commented Feb 12, 2025 • edited Loading

conceptualshark left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HanselIdes commented Feb 12, 2025

conceptualshark commented Feb 12, 2025

HanselIdes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

conceptualshark left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HanselIdes commented Feb 14, 2025

conceptualshark commented Feb 14, 2025

github-actions bot commented Feb 14, 2025

mesellings left a comment

Choose a reason for hiding this comment

HanselIdes commented Jan 14, 2025 •

edited

Loading

github-actions bot commented Jan 14, 2025 •

edited

Loading

HanselIdes commented Feb 12, 2025 •

edited

Loading