Product Documentation
ADC
14.1 - Current Release 13.1 13.0 12.1
View PDF

Sample dashboards for endpoints

February 19, 2024
Contributed by: 
C

Consider a scenario where you want to view the overall health of NetScaler in your network. To know the overall health, you need to view the data such as the total number of requests received by the virtual server, CPU utilization, currently used memory of NetScaler and so on. The Observability Sample Dashboard for NetScaler ADC provides you the visualization of some key metrics that helps you determine the health of NetScaler in less time. The Observability Sample Dashboard for NetScaler ADC is one of many dashboards that NetScaler supports.

A sample dashboard is a collection of metrics related to a particular use case/scenario that allows you to visualize the metrics and analyze the scenario in a meaningful way within a short duration. With the sample dashboards, you can avoid looking at multiple metrics in different locations or files to analyze a particular scenario.

NetScaler provides sample dashboards for the following endpoints:

  • Grafana
  • Splunk

The sample dashboards are available in the JSON format at the following location: https://www.citrix.com/downloads/citrix-adc/sample-dashboards/endpoints-and-dashboards.html

List of sample dashboards

The following table list all the sample dashboards that NetScaler supports:

Sample dashboard name Details Endpoint JSON file name
Observability Sample Dashboard for NetScaler ADC Provides various metrics of overall infrastructure at one place like NetScaler health, virtual server status, application health (HTTP and TCP apps), and application security (SSL apps). Read more Grafana Netscaler_grafana_dashboard.json
Infra and Network Health Dashboard for NetScaler ADC Provides all system metrics such as golden signals-latency, traffic, error, saturations, HA sync failures for all NetScalers on a central dashboard to ensure business continuity. Read more Splunk netscaler_infra_and_network_health_splunk_dashboard.json
App and API Health Dashboard Provides metrics for the web applications and gain clients’ insights to ensure high performing and seamless web experience for end users. Read more Splunk netscaler_app_and_api_health_splunk_dashboard.json
NetScaler HTTP Insight Dashboard Provides visibility into Web Insight. This dashboard is valid for both HTTP and HTTPS traffic, and includes commonly used data such as Response Time, Latency, NetScaler Processing Time at Layer 7, distributions such as Application Load, Response Length, Host, URL, Method, and some common HTTP headers. Read more Splunk NetScalerHTTPInsightDashboard.xml
NetScaler SSL Insight Dashboard Provides SSL insight. This dashboard includes TLS/SSL transactions or sessions related fields that are commonly looked for. For example, Ciphers and their strengths, TLS/SSL versions, certificate types. Read more Splunk NetScalerSSLInsightDashboard.xml
NetScaler TCP Insight Dashboard Provides TCP insight. This dashboard includes data such as, Throughput, Connection Length, Latency, Jitter at L4, and events such as Retransmissions, Resets, Zero Windows. Read more Splunk NetScalerTCPInsightDashboard.xml
NetScaler Management Logs Dashboard (HEC) Provides data on management logs exported to an HTTP Event Collector (HEC) input on Splunk. This dashboard includes data such as Logins, GUI Access, Shell access. Read more Splunk NetScalerManagementLogsDashboard_HEC.json
NetScaler Management Logs Dashboard (Syslog) Provides data on NetScaler management logs exported to a Syslog Input on Splunk this dashboard is a counterpart of NetScaler Management Logs Dashboard (HEC). This dashboard includes data such as Logins, GUI Access, Shell access. Read more Splunk NetScalerManagementLogsDashboard_Syslog.json

Enable additional metrics

The schema file from where the data is fetched for the dashboards might not have all the metrics enabled. Due to this, you might see that some panels on the dashboard do not have data.

You can manually edit the schema file to include these metrics. The schema file is found on NetScaler at /var/metrics_conf/schema.json. After updating the schema file, you must disable and enable the metrics. Only after disabling and enabling the metrics, the panels display the data.

To disable and enable the metrics, run the following commands:

set analytics profile <splunk_new_profile> metrics DISABLED

set analytics profile splunk_new_profile metrics ENABLED
<!--NeedCopy-->

The following is the list of metrics that are not enabled by default in the schema file:

Infra and Network Health Dashboard for NetScaler ADC:

  • cur_syshealth_disk0_size
  • cur_syshealth_disk0_used
  • cur_syshealth_disk1_size
  • cur_syshealth_disk1_used
  • cur_syshealth_ps1fail
  • ssl_cfg_tot_cards
  • ssl_num_cards_up
  • nic_err_ifOutDiscards
  • cur_syshealth_disk0_errors
  • cur_syshealth_disk1_errors
  • ha_err_sync_failure
  • ha_cur_system_state
  • ha_err_pkt_rx_ver
  • ha_err_heartbeat
  • cl_cur_enable
  • clusterd_tot_cu_timedout
  • si_tot_pkt_sent
  • si_tot_pkt_rcvd
  • ssl_tot_enc_bytes
  • ssl_tot_dec_bytes

App and API Health Dashboard:

  • tcp_err_retransmit_giveups
  • tcp_err_retransmit
  • tcp_err_stray_packets
  • tcp_cur_surgequeuelen

Observability Sample Dashboard for NetScaler ADC:

  • as_sig_num_viols
Sample dashboards for endpoints
February 19, 2024
Contributed by: 
C
February 19, 2024
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.