NetScaler Console 服务

NetScaler 遥测程序的数据治理

所有现有的 NetScaler Console 客户都必须通过上传所需的遥测数据来遵守 NetScaler 遥测程序。NetScaler 遥测程序从 14.1-28.x 版本开始启用,遥测数据会自动上传。有关详细信息,请参阅 NetScaler 遥测程序。Citrix 收集基本的许可证遥测数据以及 NetScaler 部署和功能使用遥测数据,以维护其合法权益,包括许可证合规性。NetScaler Console 配置和功能使用数据也用于管理、衡量和改进 Citrix 产品和服务。

注意:

  • 遥测数据每 24 小时自动上传一次。

  • 为了在您的 NetScaler 实例中收集和存储遥测指标,作为 2024 年 6 月 18 日发布的 NetScaler 遥测程序的一部分,以下配置已通过 NetScaler Console 推送到您的 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 文件已使用以下命令更新,用于 Gateway 遥测。NetScaler Console 每小时检查一次此命令,如果缺少此命令,则会添加它。此命令仅推送到具有 VPN 虚拟服务器配置的 NetScaler 实例:
ns_telemetry_server,<Console IP>,5140
<!--NeedCopy-->
  • 某些遥测参数是通过从 NetScaler Console 推送到 NetScaler 实例的脚本收集的。这些脚本是只读的,不会更改 NetScaler 中的任何内容。

下表提供了作为 NetScaler 遥测程序一部分收集的所需参数详细信息:

类别 描述 用途
许可证、NetScaler 部署和使用遥测 有关许可证授权、使用情况、高级 NetScaler 部署数据以及 NetScaler 功能使用情况的信息。 用于许可证合规性以及管理、衡量和改进服务。
NetScaler Console 部署和功能使用遥测 有关 Console 部署和功能使用情况的信息。 用于管理、衡量和改进服务。

所需遥测数据

下表显示了作为 NetScaler 遥测程序一部分收集的所需数据列表:

许可

Parameters Description
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 白金/企业/标准带宽
Feature Name 许可证功能名称
Host ID 设备主机 ID
License serial number 许可证序列号
License Start Date 许可证开始日期
License End Date 许可证结束日期
License SA Date 许可证订阅优势日期
tenantnslictype 许可证类型,例如 CPL、CUL
instance_id 实例的唯一标识符
instance_mode 检查实例是独立实例还是 HA 对
instance_state 实例状态(启动/关闭)
is_local_license 检查许可证是否托管在 NetScaler Console 中
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 Console 服务是否用作池化许可证服务器。
perc_discovered_vservers 已发现/授权虚拟服务器的百分比
perc_used_vservers 已使用/授权虚拟服务器的百分比
pool_cpxvcpu_entitled 总池 CPX vCPU 授权数
pool_cpxvcpu_used 总池 CPX vCPU 使用数
pool_entbw_entitled 总池企业带宽授权数 [MBps]
pool_entbw_used 总池企业带宽使用数 [MBps]
pool_entvcpu_entitled 总池企业 vCPU 授权数
pool_entvcpu_used 总池企业 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 总池白金带宽授权数 [MBps]
pool_pltbw_used 总池白金带宽使用数 [MBps]
pool_pltvcpu_entitled 总池白金 vCPU 授权数
pool_pltvcpu_used 总池白金 vCPU 使用数
pool_stdbw_entitled 总池标准带宽授权数
pool_stdbw_used 总池标准带宽使用数
pool_stdvcpu_used 总池标准 vCPU 使用数
total_discovered_vservers 已发现虚拟服务器总数
total_entitled_vservers 授权虚拟服务器总数
total_used_vservers 已使用虚拟服务器总数

NetScaler Gateway 功能使用情况

仅当您的托管 NetScaler Gateway 本地版本为 14.1-25.x 及更高版本时,才会收集以下数据遥测:

Parameters Description
accessMode 访问模式类型。例如,ICA、VPN
bytesTransferred 每个会话发送和接收的总字节数
epaScans EPA 扫描总数
features NetScaler Gateway 中启用的功能
id 使用事件的唯一标识符
prod 使用事件的原始产品和部署标识
prodVer Gateway 产品版本
email 网关用户电子邮件。注意:电子邮件 ID 将被哈希处理*。
st 拉取数据时的当前时间
type CAS 用于识别本地 Gateway 使用事件的事件类型
userName Gateway 用户名。注意:该名称将被哈希处理*。
ver 遥测事件的版本

NetScaler 部署

Parameters Description
total_active_managed_devices 处于 UP 状态的 NetScaler 实例总数
total_nsap_device NetScaler Console 中的管理分区实例总数
total_managed_devices NetScaler Console 中托管的 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 Console 中托管的 BLX 实例总数
total_cpx_device NetScaler Console 中托管的 CPX 实例总数
total_ng_device NetScaler Console 中托管的 Gateway 实例总数
total_ngvpx_device NetScaler Console 中托管的 Gateway VPX 实例总数
total_ns_device NetScaler Console 中托管的 MPX 实例总数
total_nssdx_device NetScaler Console 中托管的 SDX 实例总数
total_nsvpx_device NetScaler Console 中托管的 VPX 实例总数
total_nswg_device NetScaler Console 中托管的 Web Gateway 实例总数
total_nswgvpx_device NetScaler Console 中托管的 Web Gateway VPX 实例总数
device_id VPX 实例唯一 ID
device_platform 托管 VPX 实例的平台
state VPX 实例的当前状态(启动或关闭)
aaa_vservers AAA 虚拟服务器总数
cs_vservers 内容交换虚拟服务器总数
gslb_vservers GSLB 虚拟服务器总数
lb_vservers_http HTTP LB 虚拟服务器总数
lb_vservers_ssl SSL 虚拟服务器总数

NetScaler 功能使用情况

Parameters Description
total_aaa_devices 配置了 AAA 虚拟服务器的 NetScaler 实例总数
aaa_as_Request_tot_blocked AAA 的 appfw 配置文件阻止的 HTTP 请求总数
aaatm_as_Request_tot_blocked AAATM 的 appfw 配置文件阻止的 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 VPN 的 appfw 配置文件阻止的 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 Console 服务进行的 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 设备分类。例如,Gateway
cluster.nodes 群集节点总数
cr 缓存重定向虚拟服务器总数
cs.all 内容交换虚拟服务器总数
cs.gw 用作网关的内容交换虚拟服务器总数
cs.used 未绑定到 localhost 且为 WEB 或 TCP 协议的可寻址内容交换虚拟服务器总数
deployment_type NetScaler 部署类型(HA 对或独立)
ha.node HA 对的 IP 地址
lb.all 所有负载平衡虚拟服务器总数
lb.gw 用作网关的负载平衡虚拟服务器总数
lb.used 未绑定到 localhost 且为 WEB 或 TCP 协议的可寻址负载平衡虚拟服务器总数
nsip NetScaler 的 NSIP。注意:IP 地址将被哈希处理*。
reason 分类的详细原因
servers 虚拟服务器总数
serviceGroups 服务组总数
services 服务总数
services.dns ADNS/ADNS_TCP 类型服务总数
vpn VPN 虚拟服务器总数
vpn.ica ICA VPN 虚拟服务器总数
vservers.gw 用作网关的 LB + CS + CR 虚拟服务器总数
vservers.used 未绑定到 localhost 且为 WEB 或 TCP 协议的可寻址 LB + CS + CR 虚拟服务器总数
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 导出
collected_at 遥测脚本收集数据的时间
total_audit_logs 通过 NextGen API 配置的审计日志总数
total_backends 通过 NextGen API 配置的后端总数
total_frontends 通过 NextGen API 配置的前端总数
total_health_check 通过 NextGen API 配置的 health_check 资源总数
total_http_redirects 通过 NextGen API 配置的 HTTP 重定向总数
total_http_responders 通过 NextGen API 配置的 HTTP 响应器总数
total_load_balancing_settings 通过 NextGen API 配置的负载平衡设置总数
total_routes 通过 NextGen API 配置的路由(策略)总数
total_tls_settings 通过 NextGen API 配置的 TLS 设置总数
total_http_settings 通过 NextGen API 配置的 HTTP 设置总数
total_value_set 通过 NextGen API 配置的值集总数
total_wireshark_expressions 通过 NextGen API 配置的 wireshark 过滤器总数
last_login_time 用户上次使用 NextGen API 登录的时间戳
last_usage_time 用户上次与 NextGen API 交互的时间戳
ngapi_version NextGen API 版本
state 当前 NextGen API 状态
total_applications 通过 NextGen API 配置的应用程序总数
total_certificates 通过 NextGen API 安装的证书总数
total_failed_commit 在提交阶段失败的 NextGen API 请求总数
total_failed_install 在安装阶段失败的 NextGen API 请求总数
total_login 登录 NextGen API 接口的总次数
total_request 通过 NextGen API 接口完成的请求总数
total_resources 通过 NextGen API 配置的 NextGen API 资源总数(应用程序、证书、健康检查等)
svpn_tot_client_type_AGENT Windows 版 Citrix Secure Access 客户端总数
svpn_tot_client_type_IOS iOS 版 Citrix Secure Access 客户端总数
svpn_tot_client_type_MAC macOS 版 Citrix Secure Access 客户端总数
svpn_tot_client_type_ANDROID Android 版 Citrix Secure Access 客户端总数
svpn_tot_client_type_CVPN 通过无客户端 VPN 访问 Citrix 资源的用户或设备总数
svpn_tot_client_type_ICA 用于 ICA 访问的 Citrix Secure Access 客户端总数
ns_svpn_tot_epa_failed EPA 检查失败总数
ns_svpn_tot_epa_quarantine EPA 检查失败并隔离的总数

NetScaler Console 部署和功能使用情况

Parameters Description
platform 托管 NetScaler Console 的平台。例如,Citrix Hypervisor
csp 租户是否为 Citrix 服务提供商
customer_onboard_date Citrix Cloud 上线日期
Customer_type 客户是外部客户还是内部客户
email Citrix Cloud ID 的电子邮件 ID(从 Citrix Cloud 收集)
end_date NetScaler Console SKU 结束日期
product_sku 产品 SKU
product_sku_description 产品 SKU 的描述
service_type 租户的服务类型
session_count 过去一天的登录次数
start_date NetScaler Console SKU 开始日期
state NetScaler Console SKU 状态
built_in_agents NetScaler 实例用于与 NetScaler Console 服务通信的内置代理
page_views NetScaler Console GUI 中的总页面浏览量/访问次数
smart_deployment CADS 部署计数
botinsight_usage 是否启用机器人洞察(是或否)
data_from_adm_service 来自 ADM 服务的数据
adm_pop NetScaler Console 服务 PoP 名称
model_id NetScaler 型号类型
total_haproxy_device 类型为“haproxyhost”的设备总数
version NetScaler 内部版本、版本和发布日期
is_agt 检查是否配置了代理
is_cloud 检查 NetScaler Console 部署是 NetScaler Console 服务还是本地 NetScaler Console
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 与分析相关的总问题计数
feature 已识别问题的特征类别。该特征可以是 BOT_INSIGHT、DEVICE、GATEWAY_INSIGHT、HDX_INSIGHT、SECURITY_INSIGHT、SERVICE_GRAPH、SWG_INSIGHT、WEB_INSIGHT、WEB_SECURITY_BOT_INSIGHT
feature 负载平衡虚拟服务器上启用的分析功能
feature 内容交换虚拟服务器上启用的分析功能
feature 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 Console 的平台。例如,Citrix Hypervisor
region 部署代理的区域
total_active_agents 处于 UP 状态的代理总数
version 代理版本
city 数据中心城市
isCloud 是本地还是云
total_k8s 托管在 Kubernetes 群集上的 NetScaler Console。Kubernetes 群集总数
total_apps NetScaler Console 中的应用程序总数
total_custom_sites NetScaler Console 中配置的自定义站点总数
total_managed_apps NetScaler Console 中托管的应用程序总数
total_custom_apps NetScaler Console 中的自定义应用程序总数
root /var、/root、/flash、/var/mps 目录中的 NetScaler Console 磁盘利用率详细信息
total NetScaler Console 磁盘空间总量(单位:字节)
used 已使用的 NetScaler Console 磁盘空间总量
free 可用的 NetScaler Console 磁盘空间总量
total_api_requests 过去 24 小时内通过 API 向 NetScaler Console 发出的请求总数。这还包括远程代理用户(来自代理的请求)。
total_api_external_requests 通过 API 向 NetScaler Console 发出的请求总数,不包括来自代理的请求
total_gui_requests 过去 24 小时内登录 NetScaler Console GUI 的用户总数
total_users NetScaler Console 本地用户总数
total_config_audit NetScaler Console 中配置的配置审计模板总数
total_config_job NetScaler Console 中创建的配置作业总数
total_ssl_certs 从 NetScaler Console 创建/修改/删除的 SSL 证书总数
total_custom_event_rules NetScaler Console 中创建的自定义事件规则总数
total_success_preauth_requests 生成预认证令牌的成功请求计数
total_event_rules NetScaler Console 中创建的事件规则总数
total_ingress_deployed Kubernetes 中的入口控制器总数。
total_ipam NetScaler Console 中添加的 IPAM 提供程序总数
total_ipam_configured NetScaler Console 中添加的 IPAM 网络总数
total_network_report NetScaler Console 中创建的网络报告总数
total_pager_duty_profile NetScaler Console 中添加的 PagerDuty 配置文件总数
total_rbac_groups NetScaler Console 中配置的 RBAC 组总数
total_slack_profile NetScaler Console 中添加的 Slack 配置文件总数
total_ssl_certs 从 NetScaler Console 创建/修改/删除的 SSL 证书总数
total_stylebook_config_store_count NetScaler Console 中创建的配置包总数
total_user_sb_stylebook_count NetScaler Console 中创建的自定义配置包总数
configpack StyleBooks 中存储的配置包总数
export_end_point 数据发送到的终结点。
export_frequency 数据导出是每小时还是每天
export_type 数据发送到的目标。示例:Splunk、New Relic
gather_feature 导出哪些数据。示例:WAF、Bot
subscribed_by 添加可观察性配置的用户
subscription_name 用于识别配置的订阅名称
subscription_notification_enabled 是否为导出启用了任何通知设置

*通过遥测收集的信息(例如电子邮件地址、用户名和 IP 地址)通过使用单向哈希算法在源头对信息进行哈希处理,从而安全地进行假名化。因此,Citrix 无法访问或读取这些值。此遥测数据仅用于逻辑资产匹配目的。

NetScaler 遥测程序的数据治理