Application Delivery Management

Data governance

July 25, 2024

Contributed by:

C R

All existing NetScaler Console customers must be compliant with the NetScaler telemetry program by uploading the required telemetry data either through automated or manual mode. The NetScaler telemetry program is enabled starting from 14.1-25.53 and later / 13.1-53.22 and later build. 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.

The automated telemetry collection mode enables you to use the Security Advisory feature in NetScaler Console on-prem that collects the optional telemetry parameters. You can disable the optional parameters, but not the required parameters.

Notes:

After you upgrade to NetScaler Console 14.1-25.53 or later / 13.1-53.22 or later build, the following configuration is automatically pushed to your NetScaler instances through NetScaler Console. This configuration collects and stores the telemetry metrics in your NetScaler instances:
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

If you are in manual mode or automated mode (with any prerequisite not met), NetScaler Console continues to check for the above configuration every 24 hours and push it to NetScaler instances, if this configuration is missing. If you do not want the configuration to be pushed, you must be in the automated mode (with all prerequisites met) or upgrade to the upcoming build (14.1-29.x or 13.1-55.x).

The /nsconfig/.telemetry.conf file 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:
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 parameter details that are collected as part of NetScaler telemetry program:

Categories	Description	What do we use it for?	Required / Optional
License, and NetScaler deployment and usage telemetry	Information about license entitlement, allocation, usage, and high-level NetScaler deployment data, and NetScaler feature usage.	License compliance and to manage, measure, and improve the service.	Required
NetScaler Console deployment and feature usage telemetry	Information about Console deployment and feature usage.	To manage, measure, and improve the service.	Optional

To disable the optional parameters:

In NetScaler Console on-prem, navigate to NetScaler Telemetry and disable Security Advisory.
Navigate to Settings > Administration > Enable or disable the Console feature data sharing, and clear the I agree to share Console feature usage data checkbox.

If your NetScaler Console is between 14.1-8.x and 14.1-21.x build, the data collection is enabled after you configure Cloud Connect and enable the Security Advisory feature. For more information, see Data governance for Cloud Connect

If your NetScaler Console is 14.1-4.x or lower version, you can create a Customer Identity on Citrix Cloud to send important statistics about NetScaler Console health, status, and other metrics from NetScaler Console on-prem deployment to Citrix Cloud account. Citrix collects statistics to understand the usage of NetScaler Console. For more information, see Data governance for Customer Identity.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Data governance

July 25, 2024

Contributed by:

C R

July 25, 2024

Contributed by:

C R

Data governance

In this article