Skip to content

Commit

Permalink
Merge pull request #2809 from truenas/PD-1161-expand-usage-collection…
Browse files Browse the repository at this point in the history
…-documentation

Pd 1161 expand usage collection documentation
  • Loading branch information
micjohnson777 authored Jun 4, 2024
2 parents bb46d5b + e0b53db commit 024fd2d
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}
Expand Down
2 changes: 1 addition & 1 deletion static/includes/SystemGeneralFields.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*.
Expand Down
27 changes: 21 additions & 6 deletions static/includes/TNDataCollection.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
&NewLine;

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.
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.
The collected data helps iXsystems identify issues, plan for new features, and determine where to invest resources for future software enhancements.
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.
Information about system configuration and usage is not collected.

When enabled, non-sensitive system data is transmitted to iXsystems.
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:
Expand All @@ -21,3 +21,18 @@ 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 "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.
{{< /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 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.
{{< /hint >}}

0 comments on commit 024fd2d

Please sign in to comment.