Monitor Citrix NetScaler via ActiveGate extension to enhance security and virtualization visibility.
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
Monitor the health and performance of their NetScaler services.
Monitor NetScaler with a dedicated dashboard and Dynatrace entities to represent core components.
Detect and alert on anomalies.
Compatibility information
Citrix NetScaler ADC 12.x, 13.x, or 14.x
Activation and setup
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
Feature sets
When activating your extension using monitoring configuration, you can limit monitoring to one of the feature sets. To work properly, the extension has to collect at least one metric after the activation.
In highly segmented networks, feature sets can reflect the segments of your environment. Then, when you create a monitoring configuration, you can select a feature set and a corresponding ActiveGate group that can connect to this particular segment.
All metrics that aren't categorized into any feature set are considered to be the default and are always reported.
A metric inherits the feature set of a subgroup, which in turn inherits the feature set of a group. Also, the feature set defined on the metric level overrides the feature set defined on the subgroup level, which in turn overrides the feature set defined on the group level.
sslcertkey
Metric name
Metric key
Description
Days until SSL certificate expiry
netscaler.sslcertkey.daystoexpiration
Days remaining for the certificate to expire.
gslbservice-detail
Metric name
Metric key
Description
Total requests
netscaler.gslbservice.totalrequests.count
Total number of requests received on this service or virtual server.
Total responses
netscaler.gslbservice.totalresponses.count
Number of responses received on this service or virtual server.
Current server connections
netscaler.gslbservice.cursrvrconnections
Number of current connections to the actual servers behind the virtual server.
Current client connections
netscaler.gslbservice.curclntconnections
Number of current client connections.
Established client connections
netscaler.gslbservice.establishedconn
Number of client connections in ESTABLISHED state.
csvserver-detail
Metric name
Metric key
Description
Total vserver requests
netscaler.csvserver.totalrequests.count
Total number of requests received on this service or virtual server.
Total vserver responses
netscaler.csvserver.totalresponses.count
Number of responses received on this service or virtual server.
Current vserver Connections
netscaler.csvserver.cursrvrconnections
Number of current connections to the actual servers behind the virtual server.
Total number of response bytes received on this service or virtual server.
cmp
Metric name
Metric key
Description
HTTP Compression Bandwidth Saving
netscaler.cmp.comphttpbandwidthsaving
Bandwidth saving from HTTP compression expressed as percentage.
TCP Compression Bandwidth Saving
netscaler.cmp.comptcpbandwidthsaving
Bandwidth saving from TCP compression expressed as percentage.
nslicense
Metric name
Metric key
Description
Days until license expiry
netscaler.nslicense.daystoexpiration
Number of days until license expiry
gslbsite-basic
Metric name
Metric key
Description
Total Site Request Bytes
netscaler.gslbsite.sitetotalrequestbytes.count
Total number of request bytes received by the virtual servers represented by all GSLB services associated with this GSLB site.
Total Site Response Bytes
netscaler.gslbsite.sitetotalresponsebytes.count
Number of response bytes received by the virtual servers represented by all GSLB services associated with this GSLB site.
Interface-error
Metric name
Metric key
Description
Inbound packets hardware dropped
netscaler.Interface.rxerrors.count
Number of inbound packets dropped by the hardware on a specified interface once the NetScaler appliance starts or the interface statistics are cleared.
Outbound packets hardware dropped
netscaler.Interface.txerrors.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.
Inbound packets discarded
netscaler.Interface.indisc.count
Number of error-free inbound packets discarded by the specified interface due to a lack of resources.
Outbound packets discarded
netscaler.Interface.outdisc.count
Number of error-free outbound packets discarded by the specified interface due to a lack of resources.
Inbound packets dropped interface
netscaler.Interface.rxdrops.count
Number of inbound packets dropped by the specified interface.
Outbound packets dropped interface
netscaler.Interface.txdrops.count
Number of packets dropped in transmission by the specified interface.
service-basic
Metric name
Metric key
Description
service state
netscaler.service.state
Current state of the service.
Total Request Bytes
netscaler.service.totalrequestbytes.count
Total number of request bytes received on this service or virtual server.
Total Response Bytes
netscaler.service.totalresponsebytes.count
Number of response bytes received by this service or virtual server.
Throughput
netscaler.service.throughput
Number of bytes received or sent by this service (Mbps).
vpnvserver-basic
Metric name
Metric key
Description
vpnvserver State
netscaler.vpnvserver.state
Current state of the server.
vpnvserver Request Bytes
netscaler.vpnvserver.totalrequestbytes.count
Total number of request bytes received on this service or virtual server.
vpnvserver Response Bytes
netscaler.vpnvserver.totalresponsebytes.count
Number of response bytes received by this service or virtual server.
gslbvserver-basic
Metric name
Metric key
Description
gslbvserver state
netscaler.gslbvserver.state
Current state of the virtual server.
Total Request Bytes
netscaler.gslbvserver.totalrequestbytes.count
Total number of request bytes received on this service or virtual server.
Total Response Bytes
netscaler.gslbvserver.totalresponsebytes.count
Total number of response bytes received on this service or virtual server.
vServer Health
netscaler.gslbvserver.vslbhealth
Health of the vserver. This gives percentage of UP services bound to this vserver.
CPU Fan 0 speed. Acceptable range is 3000 through 6000 RPM. This is a critical counter.
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.
System fan speed
netscaler.system.systemfanspeed
System fan speed. Acceptable range is 3000 through 6000 RPM. This is a critical counter.
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.
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
Speed of Fan 0
netscaler.system.fan2speed
Speed of Fan 0 if associated pin is connected to health monitoring chip.
Speed of Fan 1
netscaler.system.fan3speed
Speed of Fan 1 if associated pin is connected to health monitoring chip.
Speed of Fan 2
netscaler.system.fan4speed
Speed of Fan 2 if associated pin is connected to health monitoring chip.
Speed of Fan 3
netscaler.system.fan5speed
Speed of Fan 3 if associated pin is connected to health monitoring chip.
gslbsite-detail
Metric name
Metric key
Description
Total Site Requests
netscaler.gslbsite.sitetotalrequests.count
Total number of requests received by the virtual servers represented by all GSLB services associated with this GSLB site.
Total Site Responses
netscaler.gslbsite.sitetotalresponses.count
Number of responses received by the virtual servers represented by all GSLB services associated with this GSLB site.
Current Site Client Connections
netscaler.gslbsite.sitecurclntconnections
Number of current client connections to the virtual servers represented by all GSLB services associated with this GSLB site.
Current Site Server Connections
netscaler.gslbsite.sitecursrvrconnections
Number of current connections to the real servers behind the virtual servers represented by all GSLB services associated with this GSLB site.
Interface-basic
Metric name
Metric key
Description
Interface State
netscaler.Interface.intfstate
Current state of the specified interface.
Interface Speed
netscaler.Interface.speed
Actual speed setting for this interface - actspeed.
Bytes Received
netscaler.Interface.rxbytes.count
Number of bytes received by an interface since the NetScaler appliance was started or the interface statistics were cleared.
Bytes Transmitted
netscaler.Interface.txbytes.count
Number of bytes transmitted by an interface since the NetScaler appliance was started or the interface statistics were cleared.
system-powersupplies
Metric name
Metric key
Description
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.
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.
Power supply +12V output
netscaler.system.voltagev12p
Power supply +12V output. Acceptable range is 10.80 through 13.20 volts.
Power supply +5V output
netscaler.system.voltagev5p
Power supply +5V output. Acceptable range is 4.50 through 5.50 volts.
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.
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.
CPU core 0 voltage
netscaler.system.voltagevcc0
CPU core 0 voltage. Acceptable range is 1.080 through 1.650 volts.
Pin 0 voltage
netscaler.system.auxvolt0
Voltage of a device connected to health monitoring chip through pin 0.
Pin 1 voltage
netscaler.system.auxvolt1
Voltage of a device connected to health monitoring chip through pin 1.
Pin 2 voltage
netscaler.system.auxvolt2
Voltage of a device connected to health monitoring chip through pin 2.
Pin 3 voltage
netscaler.system.auxvolt3
Voltage of a device connected to health monitoring chip through pin 3.
Pin 4 voltage
netscaler.system.auxvolt4
Voltage of a device connected to health monitoring chip through pin 4.
Pin 5 voltage
netscaler.system.auxvolt5
Voltage of a device connected to health monitoring chip through pin 5.
Pin 6 voltage
netscaler.system.auxvolt6
Voltage of a device connected to health monitoring chip through pin 6.
Pin 7 voltage
netscaler.system.auxvolt7
Voltage of a device connected to health monitoring chip through pin 7.
Power supply 1 failure status
netscaler.system.powersupply1status
Power supply 1 failure status.
Power supply 2 failure status
netscaler.system.powersupply2status
Power supply 2 failure status.
Power supply 3 failure status
netscaler.system.powersupply3status
Power supply 3 failure status.
Power supply 4 failure status
netscaler.system.powersupply4status
Power supply 4 failure status.
aaa-current
Metric name
Metric key
Description
AAATM Current Sessions
netscaler.aaa.aaacurtmsessions
Count of current AAATM sessions.
Basic ICA Sessions
netscaler.aaa.aaacuricasessions
Count of current Basic ICA only sessions.
Basic ICA Connections
netscaler.aaa.aaacuricaonlyconn
Count of current Basic ICA only connections.
SmartAccess ICA Connections
netscaler.aaa.aaacuricaconn
Count of current SmartAccess ICA connections.
Current SmartAccess AAA sessions
netscaler.aaa.aaacursessions
Count of current SmartAccess AAA sessions.
lbvserver-basic
Metric name
Metric key
Description
vserver State
netscaler.lbvserver.state
Current state of the server.
Request Bytes
netscaler.lbvserver.totalrequestbytes.count
Total number of request bytes received on this service or virtual server.
Response Bytes
netscaler.lbvserver.totalresponsebytes.count
Number of response bytes received by this service or virtual server.
Total vserver hits
netscaler.lbvserver.tothits.count
Total vserver hits
lbvserver-detail
Metric name
Metric key
Description
Total vserver requests
netscaler.lbvserver.totalrequests.count
Total number of requests received on this service or virtual server.
Total vserver responses
netscaler.lbvserver.totalresponses.count
Number of responses received on this service or virtual server.
Current vserver Connections
netscaler.lbvserver.cursrvrconnections
Number of current connections to the actual servers behind the virtual server.
Number of times traffic was diverted to backup vserver since primary vserver was DOWN.
Active Services
netscaler.lbvserver.actsvcs
number of ACTIVE services bound to a vserver
vserver Health
netscaler.lbvserver.vslbhealth
Health of the vserver. This gives percentage of UP services bound to this vserver.
vpnvserver-detail
Metric name
Metric key
Description
vpnvserver Requests
netscaler.vpnvserver.totalrequests.count
Total number of requests received on this service or virtual server.
vpnvserver Responses
netscaler.vpnvserver.totalresponses.count
Number of responses received on this service or virtual server.
system-temperature
Metric name
Metric key
Description
CPU 0 temperature
netscaler.system.cpu0temp
CPU 0 temperature. 9800 and 9960 platforms display internal chip temperature. This is a critical counter.
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.
Internal temperature of health monitoring chip
netscaler.system.internaltemp
Internal temperature of health monitoring chip. This is a critical counter.
Temperature of pin 0
netscaler.system.auxtemp0
Temperature of a device connected to health monitoring chip through pin 0.
Temperature of pin 1
netscaler.system.auxtemp1
Temperature of a device connected to health monitoring chip through pin 1.
Temperature of pin 2
netscaler.system.auxtemp2
Temperature of a device connected to health monitoring chip through pin 2.
Temperature of pin 3
netscaler.system.auxtemp3
Temperature of a device connected to health monitoring chip through pin 3.
system-disk
Metric name
Metric key
Description
Disk /flash used space
netscaler.system.disk0used
Used space in /flash partition of the hard disk.
Disk /flash available space
netscaler.system.disk0avail
Available space in /flash partition of the hard disk.
Disk /var used space
netscaler.system.disk1used
Used space in /var partition of the hard disk.
Disk /var available space
netscaler.system.disk1avail
Available space in /var partition of the hard disk.
Used /flash space (%)
netscaler.system.disk0perusage
Used space in /flash partition of the disk, as a percentage. This is a critical counter.
Used /var space (%)
netscaler.system.disk1perusage
Used space in /var partition of the disk, as a percentage. This is a critical counter.
csvserver-basic
Metric name
Metric key
Description
csvserver State
netscaler.csvserver.state
Current state of the server.
Total Request Bytes
netscaler.csvserver.totalrequestbytes.count
Total number of request bytes received on this service or virtual server.
Total Response Bytes
netscaler.csvserver.totalresponsebytes.count
Number of response bytes received by this service or virtual server.