# Wildfly

# Introducción

**Este plugin tiene como finalidad poder monitorizar Jboss/Wildfly**, en base a metricas relacionadas con su consumo, aplicaciones, threadpools y datasources.

El plugin el plugin conecta con el server y realiza toda la extracción de datos, que luego vuelca en Pandora.

# Matriz de compatibilidad

<table border="1" id="bkmrk-sistemas-donde-se-ha-1"><tbody><tr><td>**Sistemas donde se ha probado**</td><td>Rocky linux, Fedora 34</td></tr><tr><td>**Sistemas donde funciona**</td><td>Cualquier sistema linux</td></tr></tbody></table>

# Pre requisitos

- Es necesaria conectividad hacia el entorno del que se pretende recibir los datos.

# Parámetros

**Parámetros de conectividad**

<table border="1" id="bkmrk--i%2C---host-direcci%C3%B3n"><colgroup><col></col><col></col></colgroup><tbody><tr><td>-i, --host  
</td><td>Dirección IP del entorno</td></tr><tr><td>-u, --user  
</td><td>Usuario</td></tr><tr><td>-p, --password</td><td>Contraseña</td></tr></tbody></table>

**Parámetros configuración Pandora**

<table border="1" id="bkmrk---agent_name-nombre-" style="width: 68.1481%; height: 361.36px;"><colgroup><col style="width: 24.4565%;"></col><col style="width: 75.3623%;"></col></colgroup><tbody><tr style="height: 46.5938px;"><td style="height: 46.5938px;">--agent\_name  
</td><td style="height: 46.5938px;">Nombre del agente global y prefijo para todos los demás agentes creados  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--module\_prefix</td><td style="height: 29.7969px;">Prefijo para todos los módulos creados por el plugin</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--interval</td><td style="height: 29.7969px;">Intervalo de monitorización del agente</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--temporal</td><td style="height: 29.7969px;">Directorio temporal de PandoraFMS</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--data\_dir  
</td><td style="height: 29.7969px;">Directorio de datos de PandoraFMS</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--group  
</td><td style="height: 29.7969px;">Grupo de destino de PandoraFMS</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--transfer\_mode  
</td><td style="height: 29.7969px;">Modo de transferencia de datos, local o tentacle</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--tentacle\_client  
</td><td style="height: 29.7969px;">Ruta del cliente de tentacle, por defecto "tentacle\_client"</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--tentacle\_opts  
</td><td style="height: 29.7969px;">Opciones adicionales de tentacle  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">--tentacle\_port  
</td><td style="height: 29.7969px;">Puerto de tentacle  
</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">--tentacle\_address  
</td><td style="height: 46.5938px;">IP de tentacle</td></tr></tbody></table>

**Parametros para habilitar/deshabilitar chequeos**

<table border="1" id="bkmrk---scan_deployments-a" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>--scan\_deployments</td><td>Activar con 1 para habilitar el escaneo de aplicaciones, por defecto habilitado.</td></tr><tr><td>--scan\_datasources</td><td>Activar con 1 para habilitar el escaneo de datasources, por defecto habilitado.</td></tr><tr><td>--scan\_threadpools</td><td>Activar con 1 para habilitar el escaneo de threadpools, por defecto habilitado.</td></tr></tbody></table>

**Parámetros extra**

<table border="1" id="bkmrk---log_file-ruta-dond"><colgroup><col></col><col></col></colgroup><tbody><tr><td>--log  
</td><td>Comando para ver el log del entorno</td></tr></tbody></table>

# Ejecución manual

El formato de ejecución del plugin es el siguiente:

```
./pandora_jboss  --host < host > --user < user > --password <password> --agent_name < agent name > --module_prefix < prefix >
--scan_deployments < 1 or 0 > --scan_threadpools < 1 or 0 > --scan_datasources < 1 or 0 >
[ --transfer_mode < local o tentacle > ] [ --tentacle_port < tentacle_port > ] [ --tentacle_address < tentacle_address > ] [ --tentacle_client < tentacle client path ] [ --tentacle_opts < tentacle extra options ]
[ -g < group > ] [ --data_dir < data dir > ] [ --temporal < temporary directory path > ] [ --interval < interval agent monitorings in seconds > ] [ --log < 1 or 0 > ]
```

# Configuracion en PandoraFMS

Para configurar el plugin en PandoraFMS, se deben seguir los siguientes pasos :

**1. Subir el plugin a PandoraFMS, por ejemplo en la siguiente ruta:**

```
/etc/pandora/plugin
```

**2. Dirigirse al apartado plugins y crear uno nuevo:**

[![imagen.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/VNOimagen.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/VNOimagen.png)

 **3. Se le añade nombre, descripción y timeout:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/image.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/image.png)

**4. Se añade la ruta del plugin en el comando y los parámetros necesarios para la ejecución de este.**

<p class="callout info">Para cada parámetro se debe configurar una macro, siendo la sintaxis de esta macro la siguiente : \_fieldx\_, siendo x el numero posicional del parámetro, por ejemplo en la siguiente imagen vemos los parámetros que son obligatorios, los de conexion, ya que todos los demás se pueden usar con los valores default.</p>

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/6Gaimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/6Gaimage.png)

**5. Se configurar las macros anteriores, añadiendo en cada una el valor del parámetro:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/g3Bimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/g3Bimage.png)

**6.** **Una vez configurado se debe crear un módulo en un agente que ejecute el plugin. En el menu de módulos de un agente creamos un módulo de tipo plugin nuevo:**

[![imagen.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/503imagen.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/503imagen.png)

**7. En el menú de configuración del módulo, le ponemos un nombre, seleccionamos el plugin antes configurado y se le debe dar a "crear".**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/CsUimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/CsUimage.png)

**8. Se crearan los agentes en la siguiente ejecución del plugin :**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/C79image.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/C79image.png)

# Agentes y módulos generados por el plugin

- El plugin creara un **agente global** con los siguientes módulos:

<table border="1" id="bkmrk-%3Cnombre-agente%3E.data" style="border-collapse: collapse; width: 100%; height: 446.953px;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.Datasources </td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.Datasources count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.Deployments </td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.Deployments count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.Threadpools </td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.Threadpools count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.committed.heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.committed.non-heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.committed.init.heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.committed.init.non-heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.max.heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.max.non-heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.used.heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.used.non-heap-memory-usage</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo módulo&gt;.committed.server.log</td></tr></tbody></table>

A su vez, si está habilitada la monitorización de estos, creara un agente por cada :

- **Deployments**

<table border="1" id="bkmrk-%3Cprefijo-modulo%3E.con" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr><td>&lt;Prefijo modulo&gt;.context-root</td></tr><tr><td>&lt;Prefijo modulo&gt;.active-sessions</td></tr><tr><td>&lt;Prefijo modulo&gt;.expired-sessions</td></tr><tr><td>&lt;Prefijo modulo&gt;.highest-session-count</td></tr><tr><td>&lt;Prefijo modulo&gt;.max-active-sessions</td></tr><tr><td>&lt;Prefijo modulo&gt;.rejected-sessions</td></tr><tr><td>&lt;Prefijo modulo&gt;.server</td></tr><tr><td>&lt;Prefijo modulo&gt;.servlet</td></tr><tr><td>&lt;Prefijo modulo&gt;.session-avg-alive-time</td></tr><tr><td>&lt;Prefijo modulo&gt;.session-max-alive-time</td></tr><tr><td>&lt;Prefijo modulo&gt;.sessions-created</td></tr><tr><td>&lt;Prefijo modulo&gt;.virtual-host</td></tr><tr><td>&lt;Prefijo modulo&gt;.websocket</td></tr></tbody></table>

- **Threads**

<table border="1" id="bkmrk-%3Cprefijo-modulo%3E.%3Cna" style="border-collapse: collapse; width: 100%; height: 595.938px;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.active-count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.completed-task-count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.current-thread-count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.keepalive-time</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.largest-thread-count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.max-threads</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.queue-size</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.rejected-count</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt;Prefijo modulo&gt;.&lt;name thread&gt;.task-count</td></tr></tbody></table>

- **Datasources**

Creará un módulo booleano, para cada servicio, que mostrará si es True o False.