Data governance for NetScaler® telemetry program
All existing NetScaler Console customers must be compliant with the NetScaler telemetry program by uploading the required telemetry data. The NetScaler telemetry program is enabled starting from 14.1-28.x build and the telemetry data is automatically uploaded. For more information, see the NetScaler telemetry program. Citrix collects basic license telemetry data and NetScaler deployment and feature usage telemetry data for its legitimate interests, including license compliance. NetScaler Console configuration and feature usage data is also collected to manage, measure and improve Citrix products and services.
Notes:
-
The telemetry upload happens every 24 hours automatically.
-
To collect and store the telemetry metrics in your NetScaler instances, the following configuration was pushed to your NetScaler instances through NetScaler Console as part of the NetScaler telemetry program released on 18th June 2024.
enable ns feature AppFlow
add analytics profile telemetry_metrics_profile -type timeseries -outputMode prometheus -metrics ENABLED -serveMode Pull -schemaFile "./telemetry_collect_ns_metrics_schema.json" -metricsExportFrequency 300
-
The
/nsconfig/.telemetry.conffile is updated with the following command for the Gateway telemetry. NetScaler Console checks for this command every hour and adds it, if this command is missing. This command is pushed only to the NetScaler instances that have VPN virtual server configuration:
ns_telemetry_server,<Console IP>,5140
-
Some telemetry parameters are collected through scripts that are pushed from NetScaler Console to NetScaler instances. These scripts are read-only and do not change anything in NetScaler.
The following table provides the required parameter details that are collected as part of NetScaler telemetry program:
| Categories | Description | What do we use it for? |
|---|---|---|
| License, and NetScaler deployment and usage telemetry | Information about license entitlement, usage, and high-level NetScaler deployment data, and NetScaler feature usage. | License compliance and to manage, measure, and improve the service. |
| NetScaler Console deployment and feature usage telemetry | Information about Console deployment and feature usage. | To manage, measure, and improve the service. |
Related information
Required telemetry data
The data collected as part of the NetScaler telemetry program is listed in the Telemetry data governance document.
*The information collected through telemetry, such as email addresses, user names, and IP addresses, is securely pseudonymised by hashing the information at the source using one-way hashing algorithms. As a result, Citrix cannot access or read these values. This telemetry data is used solely for logical asset-matching purposes.