-
NetScaler telemetry program
-
-
-
View recommendations and manage your ADCs and applications efficiently
-
-
Use ADM log messages for managing and monitoring your infrastructure
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
NetScaler telemetry program
Citrix collects basic license telemetry data and NetScaler deployment and feature usage telemetry data for its legitimate interests, including license compliance. You may automatically or manually upload the required license and feature usage data to remain compliant with the NetScaler telemetry program described here. NetScaler Console configuration and feature usage data is also collected to manage, measure, and improve Citrix products and services. If you are an existing NetScaler Console customer, you must ensure to be compliant with the NetScaler telemetry program. We highly recommend adding NetScaler instances to NetScaler Console to improve and simplify your NetScaler operations overall and support the enhancement of our products and services by sending NetScaler feature usage data. Learn more.
You can upload the required telemetry data using the following ways:
-
Automated collection mode - This mode is enabled by default after you upgrade to 14.1 25.53 or later / 13.1-53.22 or later build. The automated mode creates an outbound connection to use the auto-enabled channel (endpoint URLs) and uploads the telemetry data automatically. You must only ensure that the endpoint URLs are reachable. Since the upload happens automatically, no action is required from your end unless the prerequisites fail. For more information, see Automated collection mode.
-
Manual collection mode - This mode is enabled only if the automated mode is disabled. You must download the required telemetry data from the NetScaler telemetry home page in NetScaler Console on-prem and complete the first upload to NetScaler Console service within 30 days. The subsequent uploads must be done every 90 days to remain compliant. For more information, see Manual collection mode.
The recommendation is to use the automated telemetry mode and upload the required data automatically, but you can also choose to disable the automated mode and upload it manually. In both automated and manual modes, data upload is required to remain compliant with the NetScaler telemetry program. You may choose to disable the optional telemetry data from being included in the data upload, but the required license compliance and feature usage telemetry data must be provided in both the automated and manual modes.
To remain compliant, the number of days since the last successful upload must not be greater than 90 days.
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 <!--NeedCopy-->
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).
If you see this configuration in your NetScaler instance and you are not using the Console analytics features and NetScaler Prometheus integration, you can use the following commands to remove the configuration:
rm analytics profile telemetry_metrics_profile
disable ns feature AppFlow
- 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 <!--NeedCopy-->
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 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.
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 |
For more information about the list of optional and required telemetry parameters, see Data governance.
Citrix requires that you transition to the most recent NetScaler Console build (14.1 25.53 or later / 13.1–53.22 or later) within 3 months starting from 18th June 2024. After upgrading to NetScaler Console 14.1 25.53 or later / 13.1–53.22 or later, one of the telemetry modes (automatic or manual) must be actively functioning. Unless you have elected manual reporting, you agree to adjust your firewalls as necessary to allow automatic telemetry reporting.
Points to note:
-
You must ensure that you transition to the latest build (14.1–25.53 and later / 13.1–53.22 and later) by 18th September 2024.
-
If you opt for manual telemetry mode, the first upload must be completed within 30 days of your transition to the above build, but no later than 18th October 2024. Thereafter the manual telemetry upload must be done every 90 days for your NetScaler Console on-prem to be compliant with the NetScaler telemetry program.
Citrix may suspend or terminate your Citrix Support for non-compliance of these requirements without liability, in addition to any other remedies Citrix may have at law or equity. These requirements do not apply to the extent prohibited by law or regulation. For more information, see Citrix License Telemetry FAQ.
Share
Share
In this article
This Preview product documentation is Cloud Software Group Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Cloud Software Group Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Cloud Software Group product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.