NetScaler 遥测计划的数据治理
所有现有 NetScaler 控制台客户都必须通过上载所需的遥测数据来遵守 NetScaler 遥测计划。NetScaler 遥测计划从 14.1-28.x 版本开始启用,遥测数据会自动上载。有关更多信息,请参阅 NetScaler 遥测计划。Citrix 出于合法利益(包括许可合规性)收集基本许可遥测数据以及 NetScaler 部署和功能使用遥测数据。还收集 NetScaler 控制台配置和功能使用情况数据,以管理、衡量和改进 Citrix 产品和服务。
备注:
遥测上载每 24 小时自动进行一次。
为了收集遥测指标并将其存储在您的 NetScaler 实例中,作为 2024 年 6 月 18 日发布的 NetScaler 遥测计划的一部分,通过 NetScaler 控制台将以下配置推送到您的 NetScaler 实例。
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-->
- 使用以下网关遥测命令更新
/nsconfig/.telemetry.conf
文件。NetScaler 控制台每小时检查一次此命令,如果缺少此命令,则进行添加。此命令仅推送到具有 VPN 虚拟服务器配置的 NetScaler 实例:ns_telemetry_server,<Console IP>,5140 <!--NeedCopy-->
- 一些遥测参数是通过脚本收集的,这些脚本从 NetScaler 控制台推送到 NetScaler 实例。这些脚本是只读的,不会更改 NetScaler 中的任何内容。
下表提供在 NetScaler 遥测计划中收集的所需参数详细信息:
类别 | 说明 | 我们用它做什么? |
---|---|---|
许可证、NetScaler 部署和使用遥测 | 有关许可授权、使用情况和高级别 NetScaler 部署数据以及 NetScaler 功能使用情况的信息。 | 许可证合规性以及管理、衡量和改进服务。 |
NetScaler 控制台部署和功能使用遥测 | 有关控制台部署和功能使用情况的信息。 | 管理、衡量和改进服务。 |
所需的遥测数据
下表显示了在 NetScaler 遥测计划中收集的所需数据列表:
许可
参数 | 说明 |
---|---|
flex_vpx_inst_entitled | 已授权的 VPX 实例总数 |
flex_vpx_inst_allocated | 分配的 VPX 实例总数 |
flex_sdx_inst_entitled | 授权的 SDX 实例总数 |
flex_sdx_inst_allocated | 分配的 SDX 实例总数 |
flex_mpx_inst_entitled | 授权的 MPX 实例总数 |
flex_mpx_inst_allocated | 分配的 MPX 实例总数 |
flex_plt_bw_entitled | 标题的白金带宽 |
flex_plt_bw_allocated | 分配的白金带宽 |
flex_ent_bw_entitled | 授权的企业带宽 |
flex_ent_bw_allocated | 分配的企业带宽 |
flex_std_bw_entitled | 授权的标准带宽 |
flex_std_bw_allocated | 分配的标准带宽 |
flex_vpx_fips_inst_entitled | 授权的 FIPS 实例总数 |
flex_vpx_fips_inst_allocated | 分配的 FIPS 实例总数 |
license_name | 许可证类型或功能名称 |
peak_license_usage | 在 NetScaler 实例上应用的许可的峰值使用量(分配) |
peak_bandwidth_usage | NetScaler 实例的峰值使用量 |
avg_license_usage | 在 NetScaler 实例上应用的许可的平均使用量(分配) |
avg_bandwidth_usage | NetScaler 实例的平均使用量 |
license_edition | Platinum/Enterprise/Standard 带宽 |
功能名称 | 许可证功能名称 |
主机 ID | 设备主机 ID |
许可证序列号 | 许可证的序列号 |
许可证起始日期 | 许可证的开始日期 |
许可证终止日期 | 许可证的结束日期 |
许可证 SA 日期 | 许可证订阅优惠日期 |
tenantnslictype | 许可证类型,例如 CPL、CUL 等 |
instance_id | 实例的唯一标识符 |
instance_mode | 检查实例是独立对还是 HA 对 |
instance_state | 实例状态(启动/关闭) |
is_local_license | 检查许可是否托管在 NetScaler 控制台中 |
is_pooled_license | 检查许可证是否为共享许可证 |
license_edition | 许可证类型(白金版/标准版/企业版) |
license_end_date | 许可证到期的总天数 |
platform | 设备类型 |
plt_license_allocation | 白金牌照分配 |
std_license_allocation | 标准许可证分配 |
ent_license_allocation | 企业许可证分配 |
nslicensingtype | 许可类型(灵活或固定) |
instance_ip_address | NetScaler 的管理 IP 地址。注意:IP 地址将经过哈希处理*。 |
total_pooled_devices | 具有池许可证的 NetScaler 实例总数(包括托管实例和非托管实例) |
is_pooled_license_server | 指示 NetScaler 控制台服务是否用作池化许可服务器。 |
perc_discovered_vservers | 已发现/授权的虚拟服务器的百分比 |
perc_used_vservers | 已使用/授权的虚拟服务器的百分比 |
pool_cpxvcpu_entitled | 已获授权的 CPX vCPU 池总数 |
pool_cpxvcpu_used | 使用的池 CPX vCPU 总数 |
pool_entbw_entitled | 授权 Enterprise 池总带宽 [MBps] |
pool_entbw_used | 使用的 Enterprise 池总带宽 [MBps] |
pool_entvcpu_entitled | 授权的 Enterprise vCPU 池总数 |
pool_entvcpu_used | 使用的 Enterprise vCPU 池总用量 |
pool_fips_instances_entitled | 授权的 FIPS 池实例总数 |
pool_fips_instances_used | 已使用的池 FIPS 实例总数 |
pool_instances_entitled | 授权的池实例总数 |
pool_instances_used | 已使用的池实例总数 |
pool_perc_bw_used | 已用带宽的百分比 |
pool_perc_instances_used | 已用实例的百分比 |
pool_perc_vcpu_used | 已使用的 vCPU 的百分比 |
pool_pltbw_entitled | 授权的 Platinum 池总带宽 [MBps] |
pool_pltbw_used | 使用的 Platinum 池总带宽 [MBps] |
pool_pltvcpu_entitled | 可获得的 Platinum vCPU 池总数 |
pool_pltvcpu_used | 使用的 Platinum vCPU 池总数 |
pool_stdbw_entitled | 已获得的池标准带宽总量 |
pool_stdbw_used | 使用的池标准带宽总量 |
pool_stdvcpu_used | 使用的 Standard vCPU 池总数 |
total_discovered_vservers | 已发现的虚拟服务器总数 |
total_entitled_vservers | 已授权的虚拟服务器总数 |
total_used_vservers | 已使用的虚拟服务器总数 |
NetScaler Gateway 功能使用情况
仅当您的托管 NetScaler Gateway 本地版本为 14.1-25.x 及更高版本时,才会收集以下数据遥测:
参数 | 说明 |
---|---|
accessMode | 访问模式的类型。例如,ICA、VPN |
bytesTransferred | 每个会话发送和接收的总字节数 |
epaScans | EPA 扫描的总次数 |
features | NetScaler Gateway 中启用的功能 |
id | 使用事件的唯一标识符 |
prod | 识别原始产品和部署使用事件 |
prodVer | Gateway 产品版本 |
网关用户的电子邮件。注意:电子邮件 ID 将经过哈希处理*。 | |
st | 提取数据的当前时间 |
type | CAS 用于识别网关本地使用事件的事件类型 |
userName | 网关用户名。注意:名称将经过哈希处理*。 |
ver | 遥测事件的版本 |
NetScaler 部署
参数 | 说明 |
---|---|
total_active_managed_devices | 处于 UP 状态的 NetScaler 实例总数 |
total_nsap_device | NetScaler 控制台中的管理分区实例总数 |
total_managed_devices | NetScaler 控制台中托管的 NetScaler 实例总数 |
instance_mode | 检查实例是独立对还是 HA 对 |
instance_state | 实例状态(启动/关闭) |
dev_pl_aws | 设备平台类型 |
dev_pl_azure | 设备平台类型 |
dev_pl_citrix_hypervisor | 设备平台类型 |
dev_pl_esx | 设备平台类型 |
dev_pl_gcp | 设备平台类型 |
dev_pl_hyper_v | 设备平台类型 |
dev_pl_kvm | 设备平台类型 |
dev_pl_unknown | 设备平台类型 |
dev_pl_vpx_on_sdx | 设备平台类型 |
total_blx_device | NetScaler 控制台中托管 BLX 实例的总数 |
total_cpx_device | NetScaler 控制台中托管 CPX 实例的总数 |
total_ng_device | NetScaler 控制台中托管的网关实例总数 |
total_ngvpx_device | NetScaler 控制台中托管的网关 VPX 实例总数 |
total_ns_device | NetScaler 控制台中托管 MPX 实例的总数 |
total_nssdx_device | NetScaler 控制台中托管 SDX 实例的总数 |
total_nsvpx_device | NetScaler 控制台中托管 VPX 实例的总数 |
total_nswg_device | NetScaler 控制台中托管的 Web Gateway 实例总数 |
total_nswgvpx_device | NetScaler 控制台中托管的 Web Gateway VPX 实例总数 |
device_id | VPX 实例的唯一 ID |
device_platform | 托管 VPX 实例的平台 |
state | VPX 实例的当前状态(启动或关闭) |
aa_vservers | AAA 虚拟服务器的总数 |
cs_vservers | 内容交换虚拟服务器的总数 |
gslb_vservers | GSLB 虚拟服务器的总数 |
lb_vservers_http | HTTP LB 虚拟服务器的总数 |
lb_vservers_ssl | SSL 虚拟服务器的总数 |
NetScaler 功能使用情况
参数 | 说明 |
---|---|
total_aaa_devices | 配置有 AAA 虚拟服务器的 NetScaler 实例总数 |
aaa_as_Request_tot_blocked | appfw 配置文件阻止的 AAA 的 HTTP 请求总数 |
aaatm_as_Request_tot_blocked | appfw 配置文件阻止的 AAATM 的 HTTP 请求总数 |
as_Requests_aaatm_lb | appfw 模块代表 aaatm_lb 模块处理的 HTTP 请求总数 |
as_Requests_vpn | appfw 模块代表 vpn 模块处理的 HTTP 请求总数 |
nsapisec_builtin_tot_hits | 来自 Project Shield 的内置 API 安全架构的总数 |
nsapisec_builtin_tot_validated_success | 成功通过 Project Shield 的内置 API 安全架构的请求总数 |
svpn_as_Request_tot_blocked | appfw 配置文件阻止的 VPN 的 HTTP 请求总数 |
appfw.appfirewallrequests | 通过 appfw 配置文件发出的 WAF 请求总数 |
appfw.appfirewallrequestsrate | 通过 appfw 配置文件发出 WAF 请求的总速率 |
appfwprofile.appfw_block | 每个配置文件被屏蔽的总数 |
appfwprofile.appfw_bypass | 每个配置文件通过的请求总数 |
appfwprofile.appfw_drop | 每个配置文件丢弃的总次数 |
appfwprofile.appfw_reset | 每个配置文件通过的重置总数 |
bot requests | 通过 appfw 配置文件发出的机器人请求总数 |
bot_signature_version | 使用的机器人签名版本 |
botrequestsrate | 通过机器人配置文件发出的机器人请求率 |
waf_signature_version | 使用的 WAF 签名版本 |
waf.as_requests | 通过所有 WAF 配置文件(还包括默认配置文件)完成的请求总数 |
waf.as_req_bytes | 通过不包括默认配置文件的所有 WAF 配置文件完成的请求总数 |
total_api_sec_deployments | 通过 NetScaler 控制台服务进行的 API 安全部署总数 |
ingress_controllers | 入口控制器的总数 |
admin_partitions | 分区总数 |
gslb_site_tot_RequestBytes | 通过 gslb 配置文件传递的请求总数(以字节为单位) |
gslb_site_tot_Requests | 通过 gslb 配置文件传递的请求总数 |
gslb_sites | gslb 站点的总数 |
gslb.services | gslb 服务的总数 |
analytics.profile | 分析配置文件总数 |
appfw.policies | AppFlow 策略的总数 |
appfw.profiles | AppFlow 配置文件总数 |
bot.policies | 机器人策略的总数 |
bot.profiles | 机器人配置文件总数 |
category | 设备分类。例如,网关 |
cluster.nodes | 群集节点的总数 |
cr | 缓存重定向虚拟服务器的总数 |
cs.all | 内容交换虚拟服务器的总数 |
cs.gw | 用作网关的内容交换虚拟服务器的总数 |
cs.used | 未绑定到本地主机和 WEB 或 TCP 协议的可寻址内容交换虚拟服务器的总数 |
deployment_type | NetScaler 部署类型(HA 对或独立) |
ha.node | HA 对的 IP 地址 |
lb.all | 所有负载平衡虚拟服务器的总数 |
lb.gw | 用作网关的负载平衡虚拟服务器的总数 |
lb.used | 未绑定到本地主机和 WEB 或 TCP 协议的可寻址负载平衡虚拟服务器的总数 |
nsip | NetScaler 的 NSIP。注意:IP 地址将经过哈希处理*。 |
原因 | 分类的详细原因 |
服务器 | 虚拟服务器的总数 |
serviceGroups | 服务组的总数 |
services | 服务总数 |
services.dns | ADNS/ADNS_TCP 类型服务的总数 |
vpn | VPN 虚拟服务器的总数 |
vpn.ica | ICA VPN 虚拟服务器的总数 |
vservers.gw | 使用网关的 LB + CS + CR 虚拟服务器的总数 |
vservers.used | 未绑定到本地主机的可寻址 LB + CS + CR 虚拟服务器以及 WEB 或 TCP 协议的总数 |
waf_protection | waf 保护类型 |
total_cs_devices | 配置了内容切换虚拟服务器的 NetScaler 实例总数 |
total_gslb_devices | 配置了全局服务器负载平衡虚拟服务器的 NetScaler 实例总数 |
total_gw_devices | 启用了 SSL VPN 的 NetScaler 实例总数 |
total_lb_devices | 配置了负载平衡虚拟服务器的 NetScaler 实例总数 |
total_lb_devices_http | 配置了负载平衡 HTTP 虚拟服务器的 NetScaler 实例总数 |
is_subscription_enabled | 订阅添加的导出配置是否已启用 |
telemetry_collected_at | 运行遥测脚本的时间 |
state | VPX 实例的当前状态(启动或关闭) |
version | 设备的编译版本 |
exp.events | 用于导出事件的分析配置文件总数 |
exp.managementlogs | 用于导出管理日志的分析配置文件总数 |
exp.metrics | 用于导出指标的分析配置文件的数量 |
exp.auditlogs | 用于将审核日志导出到 Splunk 的分析配置文件数量 |
exp.prometheus | 用于导出到 Prometheus 的分析配置文件的数量 |
gw_hdx_insights | 是否启用 HDX Insight 和 Gateway Insight 导出 |
NetScaler 控制台的部署和功能使用
参数 | 说明 |
---|---|
platform | 托管 NetScaler 控制台的平台。例如,Citrix Hypervisor |
csp | 租户是否是 Citrix 服务提供商 |
customer_onboard_date | Citrix Cloud 的加入日期 |
Customer_type | 客户是外部客户还是内部客户 |
Citrix Cloud ID 的电子邮件 ID(从 Citrix Cloud 收集) | |
end_date | NetScaler 控制台 SKU 的结束日期 |
product_sku | 产品 SKU |
product_sku_description | 产品 SKU 的描述 |
service_type | 租户的服务类型 |
session_count | 最后一天的登录次数 |
start_date | NetScaler 控制台 SKU 的开始日期 |
state | NetScaler 控制台 SKU 状态 |
built_in_agents | NetScaler 实例用于与 NetScaler 控制台服务通信的内置代理 |
page_views | NetScaler 控制台 GUI 中的总页面浏览量/访问次数 |
smart_deployment | CADS 部署次数 |
botinsight_usage | 是否启用机器人洞察(是或否) |
data_from_adm_service | |
adm_pop | NetScaler 控制台服务 PoP 名称 |
model_id | NetScaler 模型类型 |
total_haproxy_device | 类型为“haproxyhost”的设备总数 |
version | NetScaler 的构建、版本和发布日期 |
is_agt | 检查代理是否已配置 |
is_cloud | 检查 NetScaler 控制台部署是 NetScaler 控制台服务还是 NetScaler 控制台本地部署 |
number_of_ns_upgrade_jobs | 使用的升级任务总数 |
webinsight | 是否在 lb 或 cs 虚拟服务器中启用 Web Insight |
webinisight_usage | 是否有任何活跃的 hdx 会话(是或否) |
adm_analyt_hdx_apps | 来自启用了 HDX Insight 的设备的请求总数 |
adm_analyt_hdx_users | 通过虚拟桌面连接的用户数 |
adm_analyt_sec_insight | 来自启用了安全洞察的设备的请求总数 |
adm_analyt_webinsight | 来自启用 Web Insight 的设备的请求总数 |
anomalyinsight | 指示 lb 或 cs 虚拟服务器中是否启用了请求功能 |
count | 与分析相关的问题总数 |
功能 | 已确定问题的功能类别。该功能可以是 BOT_INSIGHT, DEVICE、GATEWAY_INSIGHT、HDX_INSIGHT、SECURITY_INSIGHT、SERVICE_GRAPH、SWG_INSIGHT、WEB_INSIGHT、WEB_SECURITY_BOT_INSIGHT |
功能 | 在负载平衡虚拟服务器上启用的分析功能 |
功能 | 在内容交换虚拟服务器上启用的分析功能 |
功能 | 在 VPN 虚拟服务器上启用的分析功能 |
gwinsight | 指示 VPN 虚拟服务器上是否启用了 ICA_REQUEST 功能 |
gwinsight_usage | 指明最后一天是否有 HDX 用户(是或否) |
ge_hdx_insights | 已启用 HDX Insight 和 Gateway Insight 的导出 |
issue_type | 已识别问题所属的问题类别。例如,许可、配置 |
secinsight | 表示是否在 lb 或 cs 虚拟服务器中启用了安全洞察 |
secinsight_usage | 最后一天是否发现任何安全攻击(是或否) |
sub_issue_type | 已识别问题的子问题类别。子问题可以是 NO_VIPS_LICENSED、BOT_INSIGHT_IN_ACTION_DISABLED、NS_FEATURE_DISABLED、VSERVER_WITHOUT_BOT_POLICY_BINDING、NO_COLLECTORS_PRESENT、APPFLOWPARAM_DISABLED、ICA_APPFLOW_POLICY_BINDING、VSERVER_WITHOUT_APPFIREWALL_POLICY_BINDING、SECURITY_INSIGHT_IN_ACTION_DISABLED, NO_CPX_VIPS_PRESENT、COLLECTOR_UNBOUND_IN_VSERVER、VSERVER_WITHOUT_APPFLOW_POLICY_BINDING |
total_api_discovery | 收到 API 请求的 NetScaler 实例总数 |
total_csvserver_ft_enabled | 至少启用了一项分析功能的内容切换虚拟服务器的总数 |
total_lbvserver_ft_enabled | 至少启用了一项分析功能的虚拟服务器的负载平衡总量 |
total_web_transaction_analytics | 启用了 Web 事务分析的 NetScaler 实例总数 |
agt_pl_azure | 代理平台类型 |
agt_pl_citrix_hypervisor | 代理平台类型 |
agt_pl_docker | 代理平台类型 |
agt_pl_esx | 代理平台类型 |
agt_pl_hyper_v | 代理平台类型 |
agt_pl_gcp | 代理平台类型 |
agt_pl_kvm | 代理平台类型 |
agt_pl_kubernetes | 代理平台类型 |
agt_pl_unknown | 代理平台类型 |
agt_pl_aws | 代理平台类型 |
agent_id | 已部署代理的唯一 ID |
city | 部署代理的城市 |
country | 部署代理的国家 |
platform | 托管 NetScaler 控制台的平台。例如,Citrix Hypervisor |
地理区域 | 部署代理的区域 |
total_active_agents | 处于 UP 状态的代理总数 |
version | 代理版本 |
city | 数据中心城市 |
isCloud | 无论是本地还是云端 |
total_k8s | 托管在 Kubernetes 群集上的 NetScaler 控制台。Kubernetes 群集总数 |
total_apps | NetScaler 控制台中的应用程序总数 |
total_custom_sites | 在 NetScaler 控制台中配置的定制站点总数 |
total_managed_apps | NetScaler 控制台中托管应用程序的总数 |
total_custom_apps | NetScaler 控制台中的所有定制应用程序 |
root | /var、/root、/flash、/var/mps 目录中的 NetScaler 控制台磁盘使用率详细信息 |
total | NetScaler 控制台的总磁盘空间(单位:字节) |
used | 总使用的 NetScaler 控制台磁盘空间 |
free | NetScaler 控制台的可用磁盘空间总量 |
total_api_requests | 过去 24 小时内通过 API 向 NetScaler 控制台发出的请求总数。这还包括远程代理用户(来自代理的请求)。 |
total_api_external_requests | 通过 API 向 NetScaler 控制台发送的请求总数(不包括来自代理的请求) |
total_gui_requests | 在过去 24 小时内登录到 NetScaler 控制台 GUI 的用户总数 |
total_users | NetScaler 控制台本地用户的总数 |
total_config_audit | 在 NetScaler 控制台中配置的全部配置审核模板 |
total_config_job | 在 NetScaler 控制台中创建的配置任务总数 |
total_ssl_certs | 从 NetScaler 控制台创建/修改/删除的 SSL 证书总数 |
total_custom_event_rules | 在 NetScaler 控制台中创建的定制事件规则总数 |
total_success_preauth_requests | 生成预身份验证令牌的成功请求次数 |
total_event_rules | 在 NetScaler 控制台中创建的事件规则总数 |
total_ingress_deployed | Kubernetes 中的入口控制器总数。 |
total_ipam | NetScaler 控制台中添加的 IPAM 提供商总数 |
total_ipam_configured | NetScaler 控制台中添加的 IPAM 网络总数 |
total_network_report | 在 NetScaler 控制台中创建的总网络报告 |
total_pager_duty_profile | NetScaler 控制台中添加的 PagerDuty 配置文件总数 |
total_rbac_groups | 在 NetScaler 控制台中配置的 RBAC 组总数 |
total_slack_profile | 在 NetScaler 控制台中添加的 Slack 配置文件总数 |
total_ssl_certs | 从 NetScaler 控制台创建/修改/删除的 SSL 证书总数 |
total_stylebook_config_store_count | 在 NetScaler 控制台中创建的配置包总数 |
total_user_sb_stylebook_count | 在 NetScaler 控制台中创建的定制配置包总数 |
configpack | 样书中存储的配置包总数 |
export_end_point | 发送数据的终点。 |
export_frequency | 数据导出为每小时或每天 |
export_type | 发送日期的目的地。示例:Splunk、New Relic |
gather_feature | 导出哪些数据。示例:WAF、机器人 |
subscribed_by | 添加了可观测性配置的用户 |
subscription_name | 用于标识配置的订阅名称 |
subscription_notification_enabled | 是否为导出启用了任何通知设置 |
*通过遥测收集的信息(例如电子邮件地址、用户名和 IP 地址)通过使用单向哈希算法在源头对信息进行哈希处理,从而安全地进行假名化。因此,Citrix 无法访问或读取这些值。此遥测数据仅用于逻辑资产匹配目的。