Citrix Netscaler ADC
- Product information
- Release notes
Overview
Citrix NetScaler ADCs help enterprises secure applications and data. However, they do not permit the installation of agent-based monitoring solutions. For this, Dynatrace offers remote monitoring of NetScaler devices via the Citrix NetScaler ActiveGate extension. Our extension queries devices every minute and retrieves key performance data. These metrics are paired with OneAgent data to provide real-time interaction visualization and the ability to follow transactions throughout your stack.
Use cases
This is intended for users, who:
- Would like to monitor the health and performance of their NetScaler services
This enables you to:
- Monitor NetScaler with a dedicated dashboard and Dynatrace entities to represent core components
- Detect and alert on anomalies
Get started
Activate the extension in your environment using the in-product Hub, provide the required authentication configuration. Follow the instructions and prompts within the extension settings.
- Host
- Username
- Password
- SSL preferences (Optional)
- Filters (Optional)
Details
This extension uses the Netscaler Nitro API to collect important NetScaler component metrics:
- system
- authentication (aaa)
- compression
- service
- lbvserver
- csvserver
- vpnvserver
- Interface
- servicegroup
- gslbservice
Compatibility information
Citrix NetScaler ADC
- 12.x
- 13.x
- 14.x
Extension content
Content typeNumber of items included
generic type
11
generic relationship
14
screen entities lists
12
dashboards
1
metric query
7
screen injections
8
screen layout
16
screen dql table
14
alerts
7
screen properties
10
metric metadata
141
screen chart groups
56
Feature sets
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
Feature setsNumber of metrics included
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Power supply -12V output | netscaler.system.voltagev12n | Power supply -12V output. Acceptable range is -13.20 through -10.80 volts. 9800 and 9960 platforms display standard value of -12.0V. | Count |
| Power supply -5V output | netscaler.system.voltagev5n | Power supply -5V output. Acceptable range is -5.50 through -4.50 volts. 9800 and 9960 platforms display standard value of -5.0V. | Count |
| Power supply +12V output | netscaler.system.voltagev12p | Power supply +12V output. Acceptable range is 10.80 through 13.20 volts. | Count |
| Power supply +5V output | netscaler.system.voltagev5p | Power supply +5V output. Acceptable range is 4.50 through 5.50 volts. | Count |
| Main power supply +3.3V output | netscaler.system.voltagev33main | Main power supply +3.3V output. Acceptable range is 2.970 through 3.630 volts. This is a critical counter. | Count |
| CPU core 1 voltage | netscaler.system.voltagevcc1 | CPU core 1 voltage. Acceptable range is 1.080 through 1.650 volts. If CPU 1 is not connected to the health monitoring chip, display shows voltage of CPU 0. | Count |
| CPU core 0 voltage | netscaler.system.voltagevcc0 | CPU core 0 voltage. Acceptable range is 1.080 through 1.650 volts. | Count |
| Pin 0 voltage | netscaler.system.auxvolt0 | Voltage of a device connected to health monitoring chip through pin 0. | Count |
| Pin 1 voltage | netscaler.system.auxvolt1 | Voltage of a device connected to health monitoring chip through pin 1. | Count |
| Pin 2 voltage | netscaler.system.auxvolt2 | Voltage of a device connected to health monitoring chip through pin 2. | Count |
| Pin 3 voltage | netscaler.system.auxvolt3 | Voltage of a device connected to health monitoring chip through pin 3. | Count |
| Pin 4 voltage | netscaler.system.auxvolt4 | Voltage of a device connected to health monitoring chip through pin 4. | Count |
| Pin 5 voltage | netscaler.system.auxvolt5 | Voltage of a device connected to health monitoring chip through pin 5. | Count |
| Pin 6 voltage | netscaler.system.auxvolt6 | Voltage of a device connected to health monitoring chip through pin 6. | Count |
| Pin 7 voltage | netscaler.system.auxvolt7 | Voltage of a device connected to health monitoring chip through pin 7. | Count |
| Power supply 1 failure status | netscaler.system.powersupply1status | Power supply 1 failure status. | Count |
| Power supply 2 failure status | netscaler.system.powersupply2status | Power supply 2 failure status. | Count |
| Power supply 3 failure status | netscaler.system.powersupply3status | Power supply 3 failure status. | Count |
| Power supply 4 failure status | netscaler.system.powersupply4status | Power supply 4 failure status. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| gslbservice state | netscaler.gslbservice.state | Current state of the service. | Count |
| Request Bytes | netscaler.gslbservice.totalrequestbytes.count | Total number of request bytes received on this service or virtual server. | Byte |
| Response Bytes | netscaler.gslbservice.totalresponsebytes.count | Number of response bytes received by this service or virtual server. | Byte |
| Service Provided Count | netscaler.gslbservice.vsvrservicehits.count | Number of times that the service has been provided. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| CPU 0 temperature | netscaler.system.cpu0temp | CPU 0 temperature. 9800 and 9960 platforms display internal chip temperature. This is a critical counter. | Count |
| CPU 1 temperature | netscaler.system.cpu1temp | CPU 1 temperature. 9800 and 9960 platforms display internal chip temperature. 7000, 9010 and 10010 platforms display CPU 0 temperature. This is a critical counter. | Count |
| Internal temperature of health monitoring chip | netscaler.system.internaltemp | Internal temperature of health monitoring chip. This is a critical counter. | Count |
| Temperature of pin 0 | netscaler.system.auxtemp0 | Temperature of a device connected to health monitoring chip through pin 0. | Count |
| Temperature of pin 1 | netscaler.system.auxtemp1 | Temperature of a device connected to health monitoring chip through pin 1. | Count |
| Temperature of pin 2 | netscaler.system.auxtemp2 | Temperature of a device connected to health monitoring chip through pin 2. | Count |
| Temperature of pin 3 | netscaler.system.auxtemp3 | Temperature of a device connected to health monitoring chip through pin 3. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| SmartAccess AAA Sessions | netscaler.aaa.aaatotsessions.count | Count of all SmartAccess AAA sessions. | Count |
| AAA Authentication Successes | netscaler.aaa.aaaauthsuccess.count | Count of authentication successes. | Count |
| AAA Session Timeouts | netscaler.aaa.aaatotsessiontimeout.count | Count of AAA sessions that have timed out. | Count |
| AAA Authentication Failures | netscaler.aaa.aaaauthfail.count | Count of authentication failures. | Count |
| AAATM Sessions | netscaler.aaa.aaatottmsessions.count | Count of all AAATM sessions. | Count |
| HTTP Connection Successes | netscaler.aaa.aaaauthonlyhttpsuccess.count | Count of HTTP connections that succeeded authorization. | Count |
| AAA non-http connection successes | netscaler.aaa.aaaauthnonhttpsuccess.count | Count of non HTTP connections that succeeded authorization. | Count |
| AAA HTTP Connection Failures | netscaler.aaa.aaaauthonlyhttpfail.count | Count of HTTP connections that failed authorization. | Count |
| AAA Non-HTTP Connection Failures | netscaler.aaa.aaaauthnonhttpfail.count | Count of non HTTP connections that failed authorization. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| csvserver State | netscaler.csvserver.state | Current state of the server. | Count |
| Total Request Bytes | netscaler.csvserver.totalrequestbytes.count | Total number of request bytes received on this service or virtual server. | Byte |
| Total Response Bytes | netscaler.csvserver.totalresponsebytes.count | Number of response bytes received by this service or virtual server. | Byte |
| Total vserver hits | netscaler.csvserver.tothits.count | Total vserver hits | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Disk /flash used space | netscaler.system.disk0used | Used space in /flash partition of the hard disk. | Byte |
| Disk /flash available space | netscaler.system.disk0avail | Available space in /flash partition of the hard disk. | Byte |
| Disk /var used space | netscaler.system.disk1used | Used space in /var partition of the hard disk. | Byte |
| Disk /var available space | netscaler.system.disk1avail | Available space in /var partition of the hard disk. | Byte |
| Used /flash space (%) | netscaler.system.disk0perusage | Used space in /flash partition of the disk, as a percentage. This is a critical counter. | Percent |
| Used /var space (%) | netscaler.system.disk1perusage | Used space in /var partition of the disk, as a percentage. This is a critical counter. | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Service group state | netscaler.servicegroup.state | Current state of the server. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Total vserver requests | netscaler.lbvserver.totalrequests.count | Total number of requests received on this service or virtual server. | Count |
| Total vserver responses | netscaler.lbvserver.totalresponses.count | Number of responses received on this service or virtual server. | Count |
| Current vserver Connections | netscaler.lbvserver.cursrvrconnections | Number of current connections to the actual servers behind the virtual server. | Count |
| Client connections | netscaler.lbvserver.curclntconnections | Number of current client connections. | Count |
| Tolerable Transactions | netscaler.lbvserver.toleratingttlbtransactions.count | Tolerable transactions based on APDEX threshold (>T ;; <4T). | Count |
| Frustrating Transactions | netscaler.lbvserver.frustratingttlbtransactions.count | Frustrating transactions based on APDEX threshold (>4T). | Count |
| Surge Requests | netscaler.lbvserver.surgecount.count | Number of requests in the surge queue. | Count |
| Invalid Requests and Responses | netscaler.lbvserver.invalidrequestresponse.count | Number invalid requests/responses on this vserver | Count |
| Invalid Requests and Responses Dropped | netscaler.lbvserver.invalidrequestresponsedropped.count | Number invalid requests/responses dropped on this vserver | Count |
| Backup traffic diversions | netscaler.lbvserver.totvserverdownbackuphits.count | Number of times traffic was diverted to backup vserver since primary vserver was DOWN. | Count |
| Active Services | netscaler.lbvserver.actsvcs | number of ACTIVE services bound to a vserver | Count |
| vserver Health | netscaler.lbvserver.vslbhealth | Health of the vserver. This gives percentage of UP services bound to this vserver. | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Interface State | netscaler.Interface.curintfstate | Current state of the specified interface. | Count |
| Bytes Received | netscaler.Interface.totrxbytes.count | Number of bytes received by an interface since the NetScaler appliance was started or the interface statistics were cleared. | Byte |
| Bytes Transmitted | netscaler.Interface.tottxbytes.count | Number of bytes transmitted by an interface since the NetScaler appliance was started or the interface statistics were cleared. | Byte |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| CPU Fan 0 speed | netscaler.system.cpufan0speed | CPU Fan 0 speed. Acceptable range is 3000 through 6000 RPM. This is a critical counter. | Count |
| CPU Fan 1 speed | netscaler.system.cpufan1speed | CPU Fan 1 speed. Acceptable range is 3000 through 6000 RPM. 7000 platform displays speed of CPU fan 0. This is a critical counter. | Count |
| System fan speed | netscaler.system.systemfanspeed | System fan speed. Acceptable range is 3000 through 6000 RPM. This is a critical counter. | Count |
| System fan 1 speed | netscaler.system.fan0speed | System fan 1 speed. For new platforms associated pin is connected to CPU supporting fans. For platforms in which it is not connected, it will point to System Fan. | Count |
| System fan 2 speed | netscaler.system.fanspeed | System fan 2 speed. For new platforms associated pin is connected to CPU supporting fans. For platforms in which it is not connected, it will point to System Fan | Count |
| Speed of Fan 0 | netscaler.system.fan2speed | Speed of Fan 0 if associated pin is connected to health monitoring chip. | Count |
| Speed of Fan 1 | netscaler.system.fan3speed | Speed of Fan 1 if associated pin is connected to health monitoring chip. | Count |
| Speed of Fan 2 | netscaler.system.fan4speed | Speed of Fan 2 if associated pin is connected to health monitoring chip. | Count |
| Speed of Fan 3 | netscaler.system.fan5speed | Speed of Fan 3 if associated pin is connected to health monitoring chip. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Management CPU Utilization. | netscaler.system.mgmtcpuusagepcnt | Average Management CPU utilization percentage. | Percent |
| Packet Engines CPU Utilization. | netscaler.system.pktcpuusagepcnt | Average CPU utilization percentage for all packet engines excluding management PE. | Percent |
| Resident CPU Utilization. | netscaler.system.rescpuusagepcnt | Average CPU utilization percentage. Not applicable for a single-CPU system. | Percent |
| Memory Used (MB). | netscaler.system.memuseinmb | Main memory currently in use, in megabytes. | MegaByte |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Connectivity | netscaler.system.connectivity | Netscaler successful connection percentage | Percent |
| Memory Utilization. | netscaler.system.memusagepcnt | Percentage of memory utilization on NetScaler. | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Total requests | netscaler.gslbservice.totalrequests.count | Total number of requests received on this service or virtual server. | Count |
| Total responses | netscaler.gslbservice.totalresponses.count | Number of responses received on this service or virtual server. | Count |
| Current server connections | netscaler.gslbservice.cursrvrconnections | Number of current connections to the actual servers behind the virtual server. | Count |
| Current client connections | netscaler.gslbservice.curclntconnections | Number of current client connections. | Count |
| Established client connections | netscaler.gslbservice.establishedconn | Number of client connections in ESTABLISHED state. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Inbound packets hardware dropped | netscaler.Interface.errpktrx.count | Number of inbound packets dropped by the hardware on a specified interface once the NetScaler appliance starts or the interface statistics are cleared. | Count |
| Outbound packets hardware dropped | netscaler.Interface.errpkttx.count | Number of outbound packets dropped by the hardware on a specified interface since the NetScaler appliance was started or the interface statistics were cleared. | Count |
| Inbound packets discarded | netscaler.Interface.errifindiscards.count | Number of error-free inbound packets discarded by the specified interface due to a lack of resources. | Count |
| Outbound packets discarded | netscaler.Interface.nicerrifoutdiscards.count | Number of error-free outbound packets discarded by the specified interface due to a lack of resources. | Count |
| Inbound packets dropped interface | netscaler.Interface.errdroppedrxpkts.count | Number of inbound packets dropped by the specified interface. | Count |
| Outbound packets dropped interface | netscaler.Interface.errdroppedtxpkts.count | Number of packets dropped in transmission by the specified interface. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| HTTP Compression Bandwidth Saving | netscaler.cmp.comphttpbandwidthsaving | Bandwidth saving from HTTP compression expressed as percentage. | Percent |
| TCP Compression Bandwidth Saving | netscaler.cmp.comptcpbandwidthsaving | Bandwidth saving from TCP compression expressed as percentage. | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| vpnvserver State | netscaler.vpnvserver.state | Current state of the server. | Count |
| vpnvserver Request Bytes | netscaler.vpnvserver.totalrequestbytes.count | Total number of request bytes received on this service or virtual server. | Count |
| vpnvserver Response Bytes | netscaler.vpnvserver.totalresponsebytes.count | Number of response bytes received by this service or virtual server. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| service state | netscaler.service.state | Current state of the service. | Count |
| Total Request Bytes | netscaler.service.totalrequestbytes.count | Total number of request bytes received on this service or virtual server. | Byte |
| Total Response Bytes | netscaler.service.totalresponsebytes.count | Number of response bytes received by this service or virtual server. | Byte |
| Throughput | netscaler.service.throughput | Number of bytes received or sent by this service (Mbps). | MegaBytePerSecond |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Total Requests | netscaler.service.totalrequests.count | Total number of requests received on this service or virtual server. | Count |
| Total Responses | netscaler.service.totalresponses.count | Number of responses received on this service or virtual server. | Count |
| Server connections | netscaler.service.cursrvrconnections | Number of current connections to the actual servers behind the virtual server. | Count |
| Client connections | netscaler.service.curclntconnections | Number of current client connections. | Count |
| Tolerating Transactions | netscaler.service.toleratingttlbtransactions.count | Tolerable transactions based on APDEX threshold (>T ;; <4T). | Count |
| Frustrating Transactions | netscaler.service.frustratingttlbtransactions.count | Tolerable transactions based on APDEX threshold (>T ;; <4T). | Count |
| Surge Queue Requests | netscaler.service.surgecount.count | Number of requests in the surge queue. | Count |
| Average time to first byte | netscaler.service.avgsvrttfb | Average TTFB between the NetScaler appliance and the server. | Second |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| vpnvserver Requests | netscaler.vpnvserver.totalrequests.count | Total number of requests received on this service or virtual server. | Count |
| vpnvserver Responses | netscaler.vpnvserver.totalresponses.count | Number of responses received on this service or virtual server. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Heartbeat packets received | netscaler.hanode.hatotpktrx.count | Number of heartbeat packets received from the peer node. | Count |
| Heartbeat packets sent | netscaler.hanode.hatotpkttx.count | Number of heartbeat packets sent from the peer node. | Count |
| Propagation timeouts | netscaler.hanode.haerrproptimeout.count | Number of times propagation timed out. | Count |
| Configuration synchronization failure | netscaler.hanode.haerrsyncfailure.count | Number of times the configuration of the primary and secondary nodes failed to synchronize since that last transition. | Count |
| High availability current state | netscaler.hanode.hacurstate | State of the HA node, based on its health, in a high availability setup. | Count |
| High availability node state | netscaler.hanode.hacurmasterstate | Indicates the high availability state of the node. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| vserver State | netscaler.lbvserver.state | Current state of the server. | Count |
| Request Bytes | netscaler.lbvserver.totalrequestbytes.count | Total number of request bytes received on this service or virtual server. | Byte |
| Response Bytes | netscaler.lbvserver.totalresponsebytes.count | Number of response bytes received by this service or virtual server. | Byte |
| Total vserver hits | netscaler.lbvserver.tothits.count | Total vserver hits | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Total vserver requests | netscaler.csvserver.totalrequests.count | Total number of requests received on this service or virtual server. | Count |
| Total vserver responses | netscaler.csvserver.totalresponses.count | Number of responses received on this service or virtual server. | Count |
| Current vserver Connections | netscaler.csvserver.cursrvrconnections | Number of current connections to the actual servers behind the virtual server. | Count |
| Current client Connections | netscaler.csvserver.curclntconnections | Number of current client connections. | Count |
| Tolerable Transactions | netscaler.csvserver.toleratingttlbtransactions.count | Tolerable transactions based on APDEX threshold (>T ;; <4T). | Count |
| Frustrating Transactions | netscaler.csvserver.frustratingttlbtransactions.count | Frustrating transactions based on APDEX threshold (>4T). | Count |
| Invalid requests and reponses | netscaler.csvserver.invalidrequestresponse.count | Number invalid requests/responses on this vserver | Count |
| Invalid requests and reponses dropped | netscaler.csvserver.invalidrequestresponsedropped.count | Number invalid requests/responses dropped on this vserver | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Days until license expiry | netscaler.nslicense.daystoexpiration | Number of days until license expiry | Day |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| AAATM Current Sessions | netscaler.aaa.aaacurtmsessions | Count of current AAATM sessions. | Count |
| Basic ICA Sessions | netscaler.aaa.aaacuricasessions | Count of current Basic ICA only sessions. | Count |
| Basic ICA Connections | netscaler.aaa.aaacuricaonlyconn | Count of current Basic ICA only connections. | Count |
| SmartAccess ICA Connections | netscaler.aaa.aaacuricaconn | Count of current SmartAccess ICA connections. | Count |
| Current SmartAccess AAA sessions | netscaler.aaa.aaacursessions | Count of current SmartAccess AAA sessions. | Count |
Full version history
To have more information on how to install the downloaded package, please follow the instructions on this page.
ReleaseDate
Full version history
- Add credential vault support for username and password
- Add network and interface entity types
- Add new screen definitions
Full version history
- Remove deprecated CPU Usage metric
- Update overview dashboard
Full version history
- Fix for SSL_V3_ALERT_HANDSHAKE errors - custom SSL adaptor when verify SSL is false.
Full version history
- Bug fix: Custom topology rule for gslbservice now using the correct
servicenamedimension
Full version history
- Fixed a bug where disabling feature sets would not prevent the metrics from being ingested
- Refactored the entity definition and metric dimensions to adapt to the new NetScaler SDX extension
Full version history
- All devices in the configuration are polled regardless of other device connection errors.
- Custom polling schedule setting (default of 1 minute)
- Fix the id of interface entities to include the netscaler host
Full version history
- Add entity type to extension metrics for management zones and tagging rules
- Update dependency packages
Full version history
- nslicense featureset - collect 'days until license expiry' metric
- Add user-defined metadata fields for device_name and group
Full version history
- NetScaler data collection: system, aaa, cmp, service, lbvserver, csvserver, vpnvserver, Interface, servicegroup, gslbservice
- Dynatrace entities and unified analysis screens for core components
- Overview dashboard