Citrix monitoring plugin

• Introducción
• Matriz de compatibilidad
• Prerrequisitos
• Configuración
• Contadores de rendimiento más importantes de Citrix
• Monitorización complementaria de citrix
• Módulos generados por el plugin

Introducción

Se han elegido una serie de módulos "base" en base a nuestra experiencia en monitorización de sistemas y los parámetros óptimos para diagnosticar posibles cuellos de botella en estos servidores. Para la extracción de la información  se  utiliza: 

• El software ya instalado en el sistema (WMI, Contadores de Rendimiento, Powershell), para la monitorización realizada por el plugin sin tener que instalar librerias o utilidades de terceros.
• El sistema, que se integra con el agente Windows y con la capacidad de distribuir colecciones de ficheros, de forma que se puede distribuir el plugin por un lado y las colecciones de ficheros de forma individual -por agente- y/o por política.  

Matriz de compatibilidad

Según el tipo de sistema operativo y el idioma en que se encuentre, el formato de los contadores de rendimiento podrían cambiar y habria que adaptarlos en función de dichas circunstancias. 

Prerrequisitos

Los requisitos para ejecutar el plugin son:

• Sistema con Powershell y WMI habilitados.
• Agente PandoraFMS con permisos para ejecutar scripts de Powershell.

Configuración

Instalación

Copiar el plugin al directorio de plugins del agente, distrubuyéndolo mediante file collections. Lo mismo con el archivo conf. La llamada desde el agente será similar a esta, pero usando los paths donde esté instalado el plugin y el conf. 

module_plugin "<ruta-powershell>\powershell.exe" -file C:\'<rutaplugin>\pandora_citrix.ps1' -perf C:\'<ruta-conf>\counters_data.txt' -serv C:\'<rutaconf>\services.txt’ -inc C:\'<ruta-conf>\counters_inc.txt' 2> error.log 

En el caso de que no querramos monitorizar ningún tipo de contador o solo de algún tipo específico, habria que realizar estas ejecuciones: 

• Solo con contadores generic_data:

module_plugin "<ruta-powershell>\powershell.exe" -file C:\'<rutaplugin>\pandora_citrix.ps1' -perf C:\'<ruta-conf>\counters_data.txt' -serv C:\'<rutaconf>\services.txt' 2> error.log 

• Solo con contadores generic_inc: 

module_plugin "<ruta-powershell>\powershell.exe" -file C:\'<ruta-plugin>\pandora_ citrix.ps1' -perf none -serv C:\'<ruta-conf>\services.txt'   -inc C:\'<rutaconf>\counters_inc.txt'' 2> error.log 

• Sin contadores: 

module_plugin "<ruta-powershell>\powershell.exe" -file C:\'<ruta-plugin>\pandora_ citrix.ps1' -perf none -serv C:\'<ruta-conf>\services.txt' 2> error.log 

• Con contadores y sin servicios: 

module_plugin "<ruta-powershell>\powershell.exe" -file C:\'<ruta-plugin>\pandora_ citrix.ps1' -perf C:\'<ruta-conf>\counters_data.txt' -inc C:\'<ruta-conf>\counters_inc.txt' 2> error.log 

Configuración 

Antes de todo debemos tener activada la ejecución de plugins desde el terminal de powershell Para ello debemos ejecutar este comando en la terminal de powershell: 

set-executionPolicy -Scope Process -ExecutionPolicy Bypass 

o bien 

set-executionPolicy RemoteSigned 

En el caso de que viésemos que si ejecutamos el plugin desde la terminal nos devuelve la información correctamente, pero en el caso de que lo ejecutemos en el agente de pandora no devuelve ningún resultado y en modo debug nos dice que el remote_signed no se encuentra habilitado, deberíamos añadir el siguiente módulo para que se active dentro de la ejecución del agente. Esto solo lo tenemos que añadir la primera vez, después se quedara habilitado y no tendremos problemas. 

module_begin 
module_name Remote_signed 
module_type generic_data_string 
module_exec powershell.exe –command set-executionPolicy -Scope Process -ExecutionPolicy bypass 
module_end 

o bien 

module_begin 
module_name Remote_signed 
module_type generic_data_string
module_exec powershell.exe -command set-executionPolicy RemoteSigned 
module_end 

Como hemos observado en la ejecución del plugin, va acompañado de dos o tres ficheros de configuración, uno con el nombre de los servicios y otro dos con el nombre de los contadores de rendimiento que se van a monitorizar, en uno indicaremos los contadores que queremos ver como tipo generic_data y en el segundo los que usaremos de tipo incremental ( generic_data_inc ). En el caso de que el de tipo incremental no se utilice no deberá añadirse a la ejecución. Únicamente deben llevar esta información los dos o tres ficheros de configuración. Cada servicio o cada contador de rendimiento debe estar en una línea y en el caso de que no se utilice eliminarlo del listado. 

Ejemplo de estos ficheros de configuración 

Services.txt 

Citrix Independent Management Architecture
Citrix XML
Citrix XTE Server
Citrix CPU Utilization Management/Resource Management
Citrix CPU Utilization Management/User Session sync
Citrix CPU Utilization Management/CPU Rebalancer services states
Citrix Print Manager
Citrix Virtual Memory Optimization
Citrix MF COM Remote Desktop Services/Terminal Services
Citrix WMI
Citrix Client Network
Citrix Streaming/Citrix Streaming Helper
Server
Netlogon
Remote Procedure Call (RPC)
Workstation
Print Spooler

Counters_data.txt 

\Processor(*)\% Processor Time
\System\Processor Queue Length
\Memory\Available Bytes
\Memory\Pages /sec
\Paging File\% Usage
\PhysicalDisk(_Total)\% Free Space
\LogicalDisk(_Total)\% Free Space
\LogicalDisk(_Total)\% Disk Time
\PhysicalDisk(_Total)\Current Disk Queue Length
\LogicalDisk(_Total)\Current Disk Queue Length
\LogicalDisk(_Total)\ Avg. Disk Sec/Read
\LogicalDisk(_Total)\ Avg. Disk Sec/Write
\LogicalDisk(_Total)\ Avg. Disk Sec/Transfer
\PhysicalDisk(_Total)\ Avg. Disk Sec/Read
\PhysicalDisk(_Total)\ Avg. Disk Sec/Write
\PhysicalDisk(_Total)\ Avg. Disk Sec/Transfer
\Citrix MetaFrame Presentation Server\Application Resolution Time (ms)
\Citrix MetaFrame Presentation Server\DataStore Connection Failure
\Citrix MetaFrame Presentation Server\Number of busy XML threads
\Citrix MetaFrame Presentation Server\Resolution WorkItem Queue Ready Count
\Citrix MetaFrame Presentation Server\WorkItem Queue Ready Count
\Citrix Licensing\Citrix Licensing - License Server Connection Failure
\Citrix Licensing\Citrix Licensing - Last Recorded License Check - Out Response Time
\Process(ImaSrv)\Private Bytes 

Contadores de rendimiento más importantes de Citrix

1.- Contadores de rendimiento del sistema (Citrix ) 

Nota: El nombre de todos estos contadores puede variar dependiendo de la versión y del idioma del SO utilizado. 

2.- Contadores de rendimiento XenApp 

3.- Contadores de Rendimiento Interfaz Web 

4.  Contadores de Rendimiento Xen Desktop

Get-Counter –listSet * | Select-Object -ExpandProperty Paths > counters.txt 

Una vez tengamos todos los contadores disponibles en el sistema, podemos copiar los que necesitemos en el fichero txt que acompaña a la ejecución del plugin y nos creará en PandoraFMS un módulo por contador que añadamos. 

Monitorización complementaria de citrix

Módulos de Red 

Podemos monitorizar de forma remota los diferentes puertos que deben estar operativos en nuestro entorno Citrix, aquí le indicamos los imprescindibles, pero en el siguiente catálogo tiene de forma detallada todos los puertos que usan los diferentes componentes de Citrix. 

http://support.citrix.com/content/dam/supportWS/kA460000000Cc9tCAC/Communication_Ports_ Used_By_Citrix.pdf

1.- Controller,  Consola Director y StoreFront

     Puertos 80 y/o 443 TCP

2.-  Servidor de Licencias

     Puertos 7279, 27000, 8083, 8082 TCP

Se podrá realizar esta monitorización de puertos a través del servidor de red de PandoraFMS o bien a través de módulos locales desde el mismo servidor o desde otro que quisiésemos usar para tal fin. 

Windows: 

module_begin
module_name Check port 80
module_type generic_proc
module_tcpcheck IP_Citrix_server
module_port 80
module_end

Linux:

module_begin
module_name Check port 80
module_type generic_proc
module_exec nmap IP_Citrix_server  | grep 80/tcp | awk '{print $2}' | grep open | wc -l
module_end

Monitorización Eventos Citrix 

Podemos monitorizar a parte de todo lo indicado anteriormente cualquiera de los eventos que Citrix escriba en el Log de Eventos. 

Para ellos podemos utilizar los módulos de tipo logevent. 

module_begin 
module_name Event Citrix 
module_type async_string 
module_source Application #Fuente ( Aplication, System o Security)
module_eventtype Information # Severidad: Error, Information, …
module_eventcode # Id del Evento 
module_description 
module_end 

En los siguientes enlaces podemos encontrar de forma detallada todos los eventos que se generan en  el servidor Citrix: 

Códigos de Eventos generados por PVS

Eventos de log XenDesktop Broker 

Eventos de log XenDesktop VDA 

Eventos de log XenDesktop MCS 

Eventos Web Interface 

A modo de ejemplo se indican algunos de los eventos más destacados. Recordamos que todas estas configuraciones deberán añadirse al fichero de configuración del agente ( pandora_agent.conf) 

module_begin
module_name EventControllerWrongUserAccount
module_description
module_type async_string
module_logevent module_source Application
module_eventcode 1000
module_end

module_begin
module_name EventBrokerThrottleStartupException
module_descriptio
nmodule_type async_string
module_logevent
module_source Application
module_eventcode 1004
module_end 

module_begin
module_name NoDatabaseConnectivity
module_description
module_type async_string
module_logevent
module_source Application
module_eventcode 1202
module_end 

module_begin
module_name Event_1388
module_description Monitoring interno de Citrix
module_type async_string
module_logevent
module_source Application
module_eventcode 1388
module_application HCAService
module_end 

module_begin
module_name Event_3621
module_description Citrix cannot connect to SQL Server
module_type async_string
module_logevent
module_source Application
module_eventtype Error
module_eventcode 3621
module_end 

module_begin
module_name Event_3961
module_description El recopilador de datos se ha quedado sin memoria y es posible que los datos del almacén dinámico no estén sincronizados. Elija un nuevo recopilador de datos y asegúrese de que tiene suficiente memoria en el nuevo recopilador de datos.
module_type async_string
module_logevent
module_source System
module_eventcode 3961
module_end 

module_begin
module_name Event_5774
module_description El servidor entra en periodo de gracia (no hay suficientes licencias).
module_type async_string
module_logevent
module_source system
module_eventtype Error
module_eventcode 5774
module_application MetaFrame
module_end 

module_begin
module_name Event_9014
module_description Licencia invalida
module_type async_string
module_logevent
module_source system
module_eventtype Error
module_eventcode 9014
module_application MetaFrame
module_end 

Módulos generados por el plugin

El plugin genera los siguientes módulos: 

• Users Connect.
• Citrix Sessions 

Estados servicios 

1.- Servidores XenApp

• Citrix Independent Management Architecture.
• Citrix XML.
• Citrix XTE Server.
• Citrix CPU Utilization Management/Resource Management.
• Citrix CPU Utilization Management/User Session sync.
• Citrix CPU Utilization Management/CPU Rebalancer Estados Servicios.
• Citrix Print Manager.
• Citrix Virtual Memory Optimization.
• Citrix MF COM.
• Remote Desktop Services/Terminal Services.
• Citrix WMI.
• Citrix Client Network.
• Citrix Streaming/Citrix Streaming Helper.
•  Server.
• Netlogon.
• Remote Procedure Call (RPC).
• Workstation.
• Print Spooler.

2.- Servicios XenDesktop 

• Citrix AD Identity.
• Citrix Broker.
• Citrix Configuration.
• Citrix Diagnostic Facility COM Server.
• Citrix Host.
• Citrix Machine Creation.
•  Citrix Machine Identity .

3.- Servicios de aprovisionamiento 

• Citrix PVS PXE.
• Citrix PVS Stream.
• Citrix PVS SOAP.
• Citrix PVS TFTP .
• Citrix PVS Two Stage Boot .

4.- Servicios de concesión de licencias

• Citrix License.
• Citrix Licensing WMI.

5.- Servicios de Interfaz Web 

• World Wide Web Publishing Service 

Contadores de Rendimiento más importantes 

Otro de los puntos que podemos monitorizar con este plugin es cualquiera de los contadores de Rendimiento que creamos necesarios. Más adelante se indican los más importantes para poder detectar cuellos de botella en Citrix y un listado de todos los que hay disponibles.