NetScaler Console service

NetScaler telemetry program

June 28, 2024

Contributed by:

C R

The NetScaler telemetry program is a required data collection program that enables the upload of required license and feature usage data necessary for customers to remain compliant with their maintenance and support license obligations. 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 NetScaler Telemetry program is enabled automatically starting from 14.1-28.x build.

Notes:

The telemetry upload happens every 24 hours automatically.

The following configuration is pushed automatically to your NetScaler instances through NetScaler Console:
set analytics profile ns_analytics_time_series_profile -type timeseries -outputMode avro -events ENABLED
add analytics profile telemetry_metrics_profile -type timeseries -outputMode prometheus -metrics ENABLED -serveMode Pull -schemaFile "./telemetry_collect_ns_metrics_schema.json" -metricsExportFrequency 300veMode Pull -schemaFile "./telemetry_collect_ns_metrics_schema.json" -metricsExportFrequency 300

This configuration collects and stores the telemetry metrics in your NetScaler instances. This does not enable analytics or appflow in your NetScaler instances.

Some telemetry parameters are collected through scripts that are pushed from NetScaler Console to NetScaler instances.

The following table provides the 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, allocation, 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.

For more information about the list of telemetry parameters, see Data governance.

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

NetScaler telemetry program

June 28, 2024

Contributed by:

C R

June 28, 2024

Contributed by:

C R

NetScaler telemetry program

In this article