Skip to content

Commit

Permalink
Update docs for data and privacy (#9397)
Browse files Browse the repository at this point in the history
  • Loading branch information
melindafekete authored Feb 28, 2025
1 parent 1b67b28 commit eee212f
Show file tree
Hide file tree
Showing 7 changed files with 103 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export const UpdateProject = ({ project }: IUpdateProject) => {
loading={loading}
title='General settings'
description='Projects allow you to group feature flags together in the management UI.'
documentationLink='https://docs.getunleash.io/reference/projects'
documentationLink='https://docs.getunleash.io/reference/projects#update-a-project'
documentationLinkLabel='Projects documentation'
formatApiCode={formatProjectApiCode}
compactPadding
Expand Down
1 change: 1 addition & 0 deletions website/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
22
53 changes: 29 additions & 24 deletions website/docs/understanding-unleash/data-collection.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,46 @@
---
title: Data collection
title: Data and privacy
---
At Unleash, we prioritize the privacy and security of our users' data. This document provides an overview of the data collected when running Unleash. We explain the purpose of data collection and provide instructions on managing data collection settings.

At Unleash, we prioritize the privacy and security of our customers' data. Our [architecture](/understanding-unleash/the-anatomy-of-unleash) ensures privacy by evaluating feature flags locally within the [client SDKs](/reference/sdks), meaning no user data is shared with the Unleash instance.

:::info

Unleash does not collect any personally identifiable information (PII).

:::

Unleash collects anonymous usage counts to help measure usage statistics and improve the product. The following sections explain what data we collect and how you can manage data collection settings.

## What data is collected

When running Unleash, we collect the following data:

**Version and Instance ID**: A unique identifier and version for your Unleash instance. This ID allows us to track usage statistics and measure the adoption of Unleash across different installations and helps us ensure that you're using the latest version with the most up-to-date features and security enhancements.
### Version and instance ID

**Feature Usage Data**: Starting from **Unleash 5.3**, we collect additional data related to feature usage in Unleash.
We collect a unique identifier and version number for your Unleash instance. This ID allows us to measure usage statistics and the adoption of Unleash across different installations. It also helps us ensure that you’re using the latest version with the most up-to-date features and security enhancements.

This includes the following data points:
- The number of active feature flags in use
- The total number of users in the system
- The total number of projects in the system
- The number of custom context fields defined and in use
- The number of user groups defined in the system
- The number of custom roles defined in the system
- The number of environments defined in the system
- The number of segments in active use by feature flags
- The number of custom strategies defined and in use
- The number of feature exports/imports made
### Feature usage data

All collected data is anonymous, and we only collect usage counts. This data helps us understand how features are used in Unleash, enabling us to prioritize important features and make informed decisions about deprecating features that are no longer relevant to our users.
> **Version**: `5.3+`
:::info
To improve Unleash, we collect anonymous usage statistics:
- Number of active feature flags
- Number of projects, environments, users, user groups, and custom roles
- Number of active segments, custom strategies, and custom context fields
- Number of times features flags have been exported or imported

Unleash does not collect personally identifiable information (PII).
All collected data is anonymous and limited to usage counts. This data helps us understand how features are used in Unleash, enabling us to prioritize important features and make informed decisions about deprecating features that are no longer relevant to our users.

:::
## Manage data collection settings

We recognize that privacy requirements differ across organizations. While the data collected by Unleash is limited and anonymous, we provide options to manage data collection settings:

## Managing data collection settings
We understand that privacy preferences may vary among our users. While the data collected by Unleash is limited and anonymous, we provide options to manage data collection settings:
### Disable all telemetry

**Disabling All Telemetry**: If you have previously disabled the version telemetry by setting the environment variable `CHECK_VERSION` to anything other than `true`, `t`, or `1`, then both the version telemetry and the feature telemetry will be disabled. This respects your choice to opt out of all telemetry data if you had previously disabled it.
Set the `CHECK_VERSION` environment variable to anything other than `true`, `t`, or `1`. This disables both version and feature telemetry.

**Turning Off Feature Telemetry**: To disable the collection of the new telemetry data while still allowing the version telemetry, set the environment variable `SEND_TELEMETRY` to anything other than `true`, `t`, or `1` before starting Unleash. This will ensure that the new telemetry data is not sent, but the version information is still sent.
### Disable feature telemetry

We respect your privacy choices, and we will continue to honor your decision regarding telemetry. If you have any questions or concerns about managing data collection settings or privacy, please reach out to our support team for assistance.
Set the `SEND_TELEMETRY` environment variable to anything other than `true`, `t`, or `1` before starting Unleash. This disables feature telemetry while still allowing version tracking.

6 changes: 4 additions & 2 deletions website/docs/understanding-unleash/unleash-overview.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Unleash introductory overview
title: Unleash architecture
---

One of the most important aspects of the Unleash architecture is that feature flags are evaluated directly in the client SDKs that run as part of your application. This makes flag evaluations incredibly fast (we're talking nano-seconds), scalable, and resilient against network disturbances. To achieve this, Unleash incurs a small update-delay when you change your flag configurations until it is fully propagated to your application. This delay is typically a few seconds and is configurable.
One of the most important aspects of the Unleash architecture is that feature flags are evaluated directly in the client SDKs that run as part of your application. This makes flag evaluations incredibly fast (we're talking nanoseconds), scalable, and resilient against network disturbances. To achieve this, Unleash incurs a small update-delay when you change your flag configurations until it is fully propagated to your application. This delay is typically a few seconds and is configurable.

Since feature flags are evaluated locally within the [client SDKs](/reference/sdks), no user data is shared with the Unleash instance. This ensures complete privacy of your customer data.

If you want more details you can read about [our unique architecture](https://www.getunleash.io/blog/our-unique-architecture).

Expand Down
14 changes: 10 additions & 4 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.0.0",
"private": true,
"engines": {
"node": ">=18"
"node": ">=22"
},
"scripts": {
"docusaurus": "docusaurus",
Expand All @@ -22,20 +22,26 @@
"dependencies": {
"@docusaurus/core": "^3.7.0",
"@docusaurus/plugin-client-redirects": "^3.7.0",
"@docusaurus/plugin-content-docs": "^3.7.0",
"@docusaurus/plugin-google-analytics": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@docusaurus/remark-plugin-npm2yarn": "3.7.0",
"@docusaurus/theme-mermaid": "3.7.0",
"@docusaurus/theme-common": "^3.7.0",
"@docusaurus/theme-mermaid": "^3.7.0",
"@docusaurus/utils": "^3.7.0",
"@docusaurus/utils-validation": "^3.7.0",
"@mdx-js/react": "^3.1.0",
"docusaurus-plugin-openapi-docs": "^4.2.0",
"docusaurus-plugin-remote-content": "^4.0.0",
"docusaurus-theme-openapi-docs": "^4.2.0",
"docusaurus-plugin-sass": "^0.2.6",
"docusaurus-theme-openapi-docs": "4.3.5",
"git-url-parse": "^15.0.0",
"plugin-image-zoom": "flexanalytics/plugin-image-zoom",
"prism-react-renderer": "^2.4.0",
"prism-svelte": "^0.5.0",
"react": "^18.3.1",
"react-dom": "^18.3.1"
"react-dom": "^18.3.1",
"sass": "^1.85.1"
},
"browserslist": {
"production": [
Expand Down
8 changes: 8 additions & 0 deletions website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,14 @@ main .theme-doc-breadcrumbs {
margin-top: 0;
}

.markdown > h3 {
font-size: 18px;
}

.markdown > h4 {
font-size: 15px;
}

.markdown > p {
font-size: 16px;
line-height: 22px;
Expand Down
58 changes: 50 additions & 8 deletions website/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2335,7 +2335,7 @@ __metadata:
languageName: node
linkType: hard

"@docusaurus/plugin-content-docs@npm:3.7.0":
"@docusaurus/plugin-content-docs@npm:3.7.0, @docusaurus/plugin-content-docs@npm:^3.7.0":
version: 3.7.0
resolution: "@docusaurus/plugin-content-docs@npm:3.7.0"
dependencies:
Expand Down Expand Up @@ -2559,7 +2559,7 @@ __metadata:
languageName: node
linkType: hard

"@docusaurus/theme-common@npm:3.7.0":
"@docusaurus/theme-common@npm:3.7.0, @docusaurus/theme-common@npm:^3.7.0":
version: 3.7.0
resolution: "@docusaurus/theme-common@npm:3.7.0"
dependencies:
Expand All @@ -2583,7 +2583,7 @@ __metadata:
languageName: node
linkType: hard

"@docusaurus/theme-mermaid@npm:3.7.0":
"@docusaurus/theme-mermaid@npm:^3.7.0":
version: 3.7.0
resolution: "@docusaurus/theme-mermaid@npm:3.7.0"
dependencies:
Expand Down Expand Up @@ -2668,7 +2668,7 @@ __metadata:
languageName: node
linkType: hard

"@docusaurus/utils-validation@npm:3.7.0":
"@docusaurus/utils-validation@npm:3.7.0, @docusaurus/utils-validation@npm:^3.7.0":
version: 3.7.0
resolution: "@docusaurus/utils-validation@npm:3.7.0"
dependencies:
Expand All @@ -2684,7 +2684,7 @@ __metadata:
languageName: node
linkType: hard

"@docusaurus/utils@npm:3.7.0":
"@docusaurus/utils@npm:3.7.0, @docusaurus/utils@npm:^3.7.0":
version: 3.7.0
resolution: "@docusaurus/utils@npm:3.7.0"
dependencies:
Expand Down Expand Up @@ -6756,7 +6756,19 @@ __metadata:
languageName: node
linkType: hard

"docusaurus-theme-openapi-docs@npm:^4.2.0":
"docusaurus-plugin-sass@npm:^0.2.6":
version: 0.2.6
resolution: "docusaurus-plugin-sass@npm:0.2.6"
dependencies:
sass-loader: "npm:^16.0.2"
peerDependencies:
"@docusaurus/core": ^2.0.0-beta || ^3.0.0-alpha
sass: ^1.30.0
checksum: 10c0/b5448ec386486ee1a49e9ea2a9cc9bf73a084f3150ec71a0203833f73c9ab48d5bbe98b7b95a21d5eeec5bd94fda9e3b06cf6cffa1120f2731174b7f134c38b5
languageName: node
linkType: hard

"docusaurus-theme-openapi-docs@npm:4.3.5":
version: 4.3.5
resolution: "docusaurus-theme-openapi-docs@npm:4.3.5"
dependencies:
Expand Down Expand Up @@ -8646,6 +8658,13 @@ __metadata:
languageName: node
linkType: hard

"immutable@npm:^5.0.2":
version: 5.0.3
resolution: "immutable@npm:5.0.3"
checksum: 10c0/3269827789e1026cd25c2ea97f0b2c19be852ffd49eda1b674b20178f73d84fa8d945ad6f5ac5bc4545c2b4170af9f6e1f77129bc1cae7974a4bf9b04a9cdfb9
languageName: node
linkType: hard

"import-fresh@npm:^3.1.0, import-fresh@npm:^3.3.0":
version: 3.3.0
resolution: "import-fresh@npm:3.3.0"
Expand Down Expand Up @@ -14153,6 +14172,23 @@ plugin-image-zoom@flexanalytics/plugin-image-zoom:
languageName: node
linkType: hard

"sass@npm:^1.85.1":
version: 1.85.1
resolution: "sass@npm:1.85.1"
dependencies:
"@parcel/watcher": "npm:^2.4.1"
chokidar: "npm:^4.0.0"
immutable: "npm:^5.0.2"
source-map-js: "npm:>=0.6.2 <2.0.0"
dependenciesMeta:
"@parcel/watcher":
optional: true
bin:
sass: sass.js
checksum: 10c0/f843aa1df1dca2f0e9cb2fb247e4939fd514ae4c182cdd1900a0622c0d71b40dfb1c4225f78b78e165a318287ca137ec597695db3e496408bd16a921a2bc2b3f
languageName: node
linkType: hard

"sax@npm:^1.2.4":
version: 1.4.1
resolution: "sax@npm:1.4.1"
Expand Down Expand Up @@ -15974,23 +16010,29 @@ plugin-image-zoom@flexanalytics/plugin-image-zoom:
"@docusaurus/core": "npm:^3.7.0"
"@docusaurus/module-type-aliases": "npm:^3.7.0"
"@docusaurus/plugin-client-redirects": "npm:^3.7.0"
"@docusaurus/plugin-content-docs": "npm:^3.7.0"
"@docusaurus/plugin-google-analytics": "npm:^3.7.0"
"@docusaurus/preset-classic": "npm:^3.7.0"
"@docusaurus/remark-plugin-npm2yarn": "npm:3.7.0"
"@docusaurus/theme-mermaid": "npm:3.7.0"
"@docusaurus/theme-common": "npm:^3.7.0"
"@docusaurus/theme-mermaid": "npm:^3.7.0"
"@docusaurus/types": "npm:^3.7.0"
"@docusaurus/utils": "npm:^3.7.0"
"@docusaurus/utils-validation": "npm:^3.7.0"
"@mdx-js/react": "npm:^3.1.0"
"@tsconfig/docusaurus": "npm:2.0.3"
"@types/react": "npm:^18.3.12"
docusaurus-plugin-openapi-docs: "npm:^4.2.0"
docusaurus-plugin-remote-content: "npm:^4.0.0"
docusaurus-theme-openapi-docs: "npm:^4.2.0"
docusaurus-plugin-sass: "npm:^0.2.6"
docusaurus-theme-openapi-docs: "npm:4.3.5"
git-url-parse: "npm:^15.0.0"
plugin-image-zoom: flexanalytics/plugin-image-zoom
prism-react-renderer: "npm:^2.4.0"
prism-svelte: "npm:^0.5.0"
react: "npm:^18.3.1"
react-dom: "npm:^18.3.1"
sass: "npm:^1.85.1"
typescript: "npm:5.6.3"
languageName: unknown
linkType: soft
Expand Down

0 comments on commit eee212f

Please sign in to comment.