From 3416448a5be8d59e143abc2104475c7a409a6d1a Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:03:47 -0400 Subject: [PATCH 1/8] Update DataCollectionStatement.md --- .../GettingStarted/UserAgreements/DataCollectionStatement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/SCALE/GettingStarted/UserAgreements/DataCollectionStatement.md b/content/SCALE/GettingStarted/UserAgreements/DataCollectionStatement.md index 00d1f6e86c..8ed901a3b2 100644 --- a/content/SCALE/GettingStarted/UserAgreements/DataCollectionStatement.md +++ b/content/SCALE/GettingStarted/UserAgreements/DataCollectionStatement.md @@ -5,6 +5,6 @@ weight: 30 --- TrueNAS collects non-sensitive system data and relays the data to a collector managed by iXsystems. -This system data collection is enabled by default and can be disabled in the web interface under **System Settings > General > GUI Settings > Usage collection**. +This system data collection is enabled by default and can be disabled in the web interface under **System > General > GUI > Usage collection**. {{< include file="/static/includes/TNDataCollection.md" >}} From a87d87dec223cae5fc35a3032e98dcb57b15c994 Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:03:51 -0400 Subject: [PATCH 2/8] Update GeneralSettings.md --- .../SCALETutorials/SystemSettings/General/GeneralSettings.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/SCALE/SCALETutorials/SystemSettings/General/GeneralSettings.md b/content/SCALE/SCALETutorials/SystemSettings/General/GeneralSettings.md index 878a53f442..045da4e9bc 100644 --- a/content/SCALE/SCALETutorials/SystemSettings/General/GeneralSettings.md +++ b/content/SCALE/SCALETutorials/SystemSettings/General/GeneralSettings.md @@ -57,6 +57,8 @@ To send failed HTTP request data which can include client and server IP addresse ### Sending Usage Statistics to iXsystems To send anonymous usage statistics to iXsystems, select the **Usage Collection** option. +For more information about what usage data is collected, see the [TrueNAS Data Collection Statement]({{< relref "/SCALE/GettingStarted/UserAgreements/DataCollectionStatement.md" >}}). + ### Showing Console Messages To display console messages in real time at the bottom of the browser, select the **Show Console Messages** option. From 32ce9801cc4c7f0face980ea30db896c2752b50d Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:03:53 -0400 Subject: [PATCH 3/8] Update GeneralSettingsScreens.md --- .../SCALEUIReference/SystemSettings/GeneralSettingsScreens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/SCALE/SCALEUIReference/SystemSettings/GeneralSettingsScreens.md b/content/SCALE/SCALEUIReference/SystemSettings/GeneralSettingsScreens.md index ff73f552ab..38f2526dce 100644 --- a/content/SCALE/SCALEUIReference/SystemSettings/GeneralSettingsScreens.md +++ b/content/SCALE/SCALEUIReference/SystemSettings/GeneralSettingsScreens.md @@ -121,7 +121,7 @@ Click **Settings** to open the **GUI Settings** screen. | **Web Interface HTTPS Port** | Enter a port number for an HTTPS connection to the web interface. This field allows configuring a non-standard port to access the GUI over HTTPS. | | **HTTPS Protocols** | Select the [Transport Layer Security (TLS)](https://en.wikipedia.org/wiki/Transport_Layer_Security) versions TrueNAS SCALE can use for connection security from the dropdown list. Cryptographic protocol for securing client/server connections. | | **Web Interface HTTP -> HTTPS Redirect** | Select to redirect HTTP connections to HTTPS. A GUI SSL Certificate is required for HTTPS. Activating this also sets the [HTTP Strict Transport Security (HSTS)](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) maximum age to 31536000 seconds (one year). This means that after a browser connects to the web interface for the first time, the browser continues to use HTTPS and renews this setting every year. | -| **Usage Collection** | Select to enable sending anonymous usage statistics to iXsystems. | +| **Usage Collection** | Select to enable sending anonymous usage statistics to iXsystems. For more information about what usage data is collected, see the [TrueNAS Data Collection Statement]({{< relref "/SCALE/GettingStarted/UserAgreements/DataCollectionStatement.md" >}}). | | **Show Console Messages** | Select to display console messages in real-time at the bottom of the browser. | {{< /truetable >}} {{< /expand >}} From a18fd7688c68d3ad6344d1f896e166cd69807319 Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:03:58 -0400 Subject: [PATCH 4/8] Update SystemGeneralFields.md --- static/includes/SystemGeneralFields.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/includes/SystemGeneralFields.md b/static/includes/SystemGeneralFields.md index f6a8f5d401..f89ccc7c17 100644 --- a/static/includes/SystemGeneralFields.md +++ b/static/includes/SystemGeneralFields.md @@ -32,7 +32,7 @@ | Name | Description | |------|-------------| | Crash reporting | Send failed HTTP request data which can include client and server IP addresses, failed method call tracebacks, and middleware log file contents to iXsystems. | -| Usage collection | Enable sending anonymous usage statistics to iXsystems. | +| Usage collection | Enable sending anonymous usage statistics to iXsystems. For more information about what usage data is collected, see the [TrueNAS Data Collection Statement]({{< relref "/CORE/GettingStarted/UserAgreements/DataCollectionStatement.md" >}}). | {{< /truetable >}} **SAVE CONFIG**: Saves a backup copy of the current configuration database in the format *hostname-version-architecture*. From 7b04ebf5ff2c928060425adee938bf53847e7985 Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:04:04 -0400 Subject: [PATCH 5/8] Update TNDataCollection.md --- static/includes/TNDataCollection.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/static/includes/TNDataCollection.md b/static/includes/TNDataCollection.md index b9eeccd089..26822eb2e9 100644 --- a/static/includes/TNDataCollection.md +++ b/static/includes/TNDataCollection.md @@ -1,12 +1,13 @@ 
 -When disabled, no information about system configuration and usage is collected. -The system capacity and software version is still collected. - The protocol for system data collection uses the same TCP ports as HTTPS (*443*) and passes through most firewalls as an outgoing web connection. If a firewall blocks the data collection or the data collection is disabled, there is no adverse impact to the TrueNAS system. -Non-sensitive system data is used to identify the quality and operational trends in the fleet of TrueNAS systems used by the entire community. +When **Usage collection** is disabled, anonymous usage statistics consisting only of the software version and total system capacity (e.g. TrueNAS SCALE 24.04.0, 55 TB) are still collected. +No information about system configuration and usage is collected. + +When enabled, non-sensitive system data is transmitted to iXsystems. +This data is used to identify the quality and operational trends in the fleet of TrueNAS systems used by the entire community. The collected data helps iXsystems identify issues, plan for new features, and determine where to invest resources for future software enhancements. The non-sensitive system data collected is clearly differentiated from sensitive user data that is explicitly not collected by TrueNAS. @@ -21,3 +22,20 @@ This table describes the differences: | | User-created System and dataset names | Software versions, firmware versions | | | Directory, files names, user data | Services and features enabled, Usage and Performance statistics | {{< /truetable >}} + +{{< expand "Which Non-Sensitive System Data is Collected? " "v" >}} +To review system usage data collected by TrueNAS, access the system shell via SSH or the console and enter `midclt call usage.gather`. +This command returns the same data that is transmitted to iXsystems when **Usage collection** is enabled. + +You can also review the [usage service plugin](https://github.com/truenas/middleware/blob/master/src/middlewared/middlewared/plugins/usage.py) itself. +{{< /expand >}} + +TrueNAS does not collect any user-defined names for servers, pools, datasets, shares, files, applications/jails, processes, and similar. +In TrueNAS SCALE, applications do transmit chart release names for deployed applications (e.g. “minio/2.0.6”) but not user-defined names. + +{{< hint type=important title="Debug files do contain sensitive user data" >}} +While **Usage collection** collects only non-sensitive system data, sensitive user data is included in a TrueNAS-generated [debug file](https://www.truenas.com/docs/contributing/issuereporting/jiraissuereporting/#downloading-a-debug-file), such as such as those requested for a bug report, feature request, or other troubleshooting. +Always store debug files in a secure location. +Please review debugs and redact any sensitive information before sharing with external entities. +The [iXsystems Privacy Policy](https://www.ixsystems.com/privacy-policy/) contains a detailed statement of our commitment to data privacy. +{{< /hint >}} From 5b1ea4dda6b95976e440114e16b3a058b645cec2 Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:25:38 -0400 Subject: [PATCH 6/8] Update TNDataCollection.md --- static/includes/TNDataCollection.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/static/includes/TNDataCollection.md b/static/includes/TNDataCollection.md index 26822eb2e9..3caf1d18c1 100644 --- a/static/includes/TNDataCollection.md +++ b/static/includes/TNDataCollection.md @@ -23,11 +23,11 @@ This table describes the differences: | | Directory, files names, user data | Services and features enabled, Usage and Performance statistics | {{< /truetable >}} -{{< expand "Which Non-Sensitive System Data is Collected? " "v" >}} +{{< expand "Reviewing Usage Collection" "v" >}} To review system usage data collected by TrueNAS, access the system shell via SSH or the console and enter `midclt call usage.gather`. -This command returns the same data that is transmitted to iXsystems when **Usage collection** is enabled. +This command returns the same statistics that are transmitted to iXsystems when **Usage collection** is enabled. -You can also review the [usage service plugin](https://github.com/truenas/middleware/blob/master/src/middlewared/middlewared/plugins/usage.py) itself. +You can also review the [usage service plugin](https://github.com/truenas/middleware/blob/master/src/middlewared/middlewared/plugins/usage.py) in the TrueNAS GitHub repository. {{< /expand >}} TrueNAS does not collect any user-defined names for servers, pools, datasets, shares, files, applications/jails, processes, and similar. From 460c8545cc51ef5e307c5bc9dc1825f42a186ab6 Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:59:10 -0400 Subject: [PATCH 7/8] Update TNDataCollection.md --- static/includes/TNDataCollection.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/static/includes/TNDataCollection.md b/static/includes/TNDataCollection.md index 3caf1d18c1..91645ecfbf 100644 --- a/static/includes/TNDataCollection.md +++ b/static/includes/TNDataCollection.md @@ -26,8 +26,6 @@ This table describes the differences: {{< expand "Reviewing Usage Collection" "v" >}} To review system usage data collected by TrueNAS, access the system shell via SSH or the console and enter `midclt call usage.gather`. This command returns the same statistics that are transmitted to iXsystems when **Usage collection** is enabled. - -You can also review the [usage service plugin](https://github.com/truenas/middleware/blob/master/src/middlewared/middlewared/plugins/usage.py) in the TrueNAS GitHub repository. {{< /expand >}} TrueNAS does not collect any user-defined names for servers, pools, datasets, shares, files, applications/jails, processes, and similar. From 58758c390be173818b63375b06444183706cbb05 Mon Sep 17 00:00:00 2001 From: DjP-iX <133042991+DjP-iX@users.noreply.github.com> Date: Tue, 4 Jun 2024 10:57:48 -0400 Subject: [PATCH 8/8] Apply suggestions from code review Co-authored-by: MicJ <92740932+micjohnson777@users.noreply.github.com> --- static/includes/TNDataCollection.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/static/includes/TNDataCollection.md b/static/includes/TNDataCollection.md index 91645ecfbf..4965c9d128 100644 --- a/static/includes/TNDataCollection.md +++ b/static/includes/TNDataCollection.md @@ -1,14 +1,13 @@ 
 -The protocol for system data collection uses the same TCP ports as HTTPS (*443*) and passes through most firewalls as an outgoing web connection. +The protocol for system data collection uses the same TCP ports as HTTPS (443) and passes through most firewalls as an outgoing web connection. If a firewall blocks the data collection or the data collection is disabled, there is no adverse impact to the TrueNAS system. When **Usage collection** is disabled, anonymous usage statistics consisting only of the software version and total system capacity (e.g. TrueNAS SCALE 24.04.0, 55 TB) are still collected. -No information about system configuration and usage is collected. +Information about system configuration and usage is not collected. When enabled, non-sensitive system data is transmitted to iXsystems. -This data is used to identify the quality and operational trends in the fleet of TrueNAS systems used by the entire community. -The collected data helps iXsystems identify issues, plan for new features, and determine where to invest resources for future software enhancements. +iXsystems collects this data and uses it to identify the quality and operational trends in the fleet of TrueNAS systems used by the entire community, to identify issues, plan for new features, and determine where to invest resources for future software enhancements. The non-sensitive system data collected is clearly differentiated from sensitive user data that is explicitly not collected by TrueNAS. This table describes the differences: @@ -32,7 +31,7 @@ TrueNAS does not collect any user-defined names for servers, pools, datasets, sh In TrueNAS SCALE, applications do transmit chart release names for deployed applications (e.g. “minio/2.0.6”) but not user-defined names. {{< hint type=important title="Debug files do contain sensitive user data" >}} -While **Usage collection** collects only non-sensitive system data, sensitive user data is included in a TrueNAS-generated [debug file](https://www.truenas.com/docs/contributing/issuereporting/jiraissuereporting/#downloading-a-debug-file), such as such as those requested for a bug report, feature request, or other troubleshooting. +While usage collection gathers only non-sensitive system data, sensitive user data is included in a TrueNAS-generated [debug file](https://www.truenas.com/docs/contributing/issuereporting/jiraissuereporting/#downloading-a-debug-file), such as those requested for a bug report, feature request, or other troubleshooting. Always store debug files in a secure location. Please review debugs and redact any sensitive information before sharing with external entities. The [iXsystems Privacy Policy](https://www.ixsystems.com/privacy-policy/) contains a detailed statement of our commitment to data privacy.