TOTVS Fluig Español

Árvore de páginas

Índice.

Objetivo.

El objetivo de esta guía es explicar como instalar y utilizar el módulo de monitoreo de servicios del TOTVS Fluig Plataforma.

Este módulo, permite que los clientes monitoricen servicios y realicen consultas de diversos informe referente a servicios consumidos por el Fluig.

Instalación y Configuración

Para instalar el módulo es necesario solicitar que el módulo .war se publique manualmente en el servidor de aplicación ya que este no viene habilitado por estándar en el instalador del TOTVS Fluig Plataforma. No es necesaria ninguna configuración adicional.

Recordando que como no existe control de accesos al monitor, para cortar su acceso se debe realizar la remoción del servidor de aplicación después de su uso.

Siga los pasos a continuación:

  • Realice el download del archivo monitor.war - Versión 1.3.8 - Actualizado el 03/10/2014.
  • Copie el archivo para el directorio "<Directorio de instalación>/jboss/apps" .
  • Aguarde el deploy del archivo .war y acceda la URL "http://<host>/monitor/report" para confirmar el éxito de la instalación.

Funcionamiento

El módulo de monitoreo permite la consulta de una serie de informes referente a servicios en uso por el TOTVS Fluig Plataforma. Estas informaciones son útiles para la depuración de algún problema que pueda estar ocurriendo en la plataforma. El acceso a los informes pueden ser realizados a través de una API Rest (que retorna un JSON) y vía JMX. En primer lugar, vamos a resumir cada uno de los servicios monitorizados.

Servicios Monitorizados

A continuación, la relación del nombre de todos los monitores y sus servicios monitorizados. Algunos servicios pueden recibir parámetros, hablaremos más sobre su uso en los próximos ítems.

Atención

Icon

Siempre que un monitor devuelva UNKNOWN o FAILURE es posible acceder el archivo "<Directorio de instalación>/jboss/standalone/logs/server.log" para obtener informaciones detalladas del error ocurrido.

ConnectedUsersMonitor

Indica el número de sesiones de usuarios activos en el portal.

Parámetros: 

  • jmxPort=<parámetro> Puerta de acceso JMX.

    Nota

    Icon

    Por estándar, la puerta de acceso JMX es 9999.

Devoluciones:

  • Número de sesiones activas en el portal;
  • UNKNOWN: Se produjo un error inesperado mientras generaba el informe.

DatabaseAvailabilityMonitor

Indica si la base utilizada por el TOTVS Fluig Plataforma está disponible.

Devoluciones:

  • OK: Base de datos disponible;
  • FAILURE: Base de datos no está disponible.

DatabaseSizeMonitor

Indica el tamaño total de la base de datos utilizada por el TOTVS Fluig Plataforma.

Devoluciones:

  • Tamaño total de la base de datos;
  • FAILURE: Se produjo un error al obtener el tamaño de la base de datos.
  • UNSUPPORTED: Banco de datos utilizado no es soportado para este monitor.

DatabaseTrafficMonitor

Indica el tráfico de envío y de recepción de la base de datos utilizada por el TOTVS Fluig Plataforma.

Devoluciones:

  • Tráfico de envío y de recepción de la base de datos;
  • FAILURE: Se produjo un error al obtener los datos de envío y de recepción de la base de datos.
  • UNSUPPORTED: Banco de datos utilizado no es soportado para este monitor.

GoodDataAvailabilityMonitor

Indica la disponibilidad del Fluig Analytics (http://analytics.fluig.com/).

Devoluciones:

  • OK: Servicio del Fluig Analytics disponible;
  • FAILURE: No se pudo acceder la dirección del Fluig Analytics;
  • UNKNOWN: Se produjo un error inesperado mientras generaba el informe.

IdentityAvailabilityMonitor

Indica si la home page del Identity está accesible.

Devoluciones:

  • OK: Home page del Identity accesible;
  • FAILURE: No fue posible acceder la home page del Identity.
  • UNKNOWN: Se produjo un error inesperado mientras generaba el informe.

IdentityConfigurationMonitor

Indica si la configuración en el standalone.xml del Identity está activa.

Devoluciones:

  • OK: Identity está activo;
  • FAILURE: Identity no está activo.

LicenseServerAvailabilityMonitor

Indica si el servidor de licencias está disponible.

Devoluciones:

  • OK: Servidor de licencias disponible;
  • FAILURE: Servidor de licencias no está disponible.

LogDirSizeMonitor

Indica el tamaño del directorio de logs del servidor.

Devolución:

  • Tamaño del directorio de logs del servidor de aplicación.

MailServerAvailabilityMonitor

Envía un e-mail de prueba para [email protected], para indicar la disponibilidad del servicio de e-mails.

Parámetros: 

  •  toAddress=<parámetro> Email de destino de la prueba.

Devoluciones:

  • OK: Servicio de e-mails disponible;
  • FAILURE: No fue posible enviar el e-mail de prueba.

MemcachedAvailabilityMonitor

Indica la disponibilidad del servidor de cache.

Devoluciones:

  • OK: Servidor de cache está disponible;
  • FAILURE: Servidor de cache no está disponible.

MemcachedConfigurationMonitor

Indica si la configuración de la dirección del servidor de cache, en el standalone.xml, está definida para algo diferente de "LOCAL_MAP".

Devoluciones:

  • OK:  Endereço do servidor de cache está configurado;
  • FAILURE: Dirección del servidor de cache no está configurado.

NodeJSAvailabilityMonitor

Indica si el servidor del NodeJS está activo.

Devoluciones:

  • OK: Servidor del NodeJS está activo;
  • FAILURE: Servidor del NodeJS no está activo.

OpenOfficeServerAvailabilityMonitor

Indica si el servidor del OpenOffice está activo.

Devoluciones:

  • OK: Servidor del OpenOffice está activo;
  • FAILURE: Servidor del OpenOffice no está activo.

SolrServerAvailabilityMonitor

Indica si el servidor del Solr está activo.

Devoluciones:

  • OK: Servidor del Solr está activo;
  • FAILURE: Servidor del Solr no está activo.

TemplateDirSizeMonitor

Indica el tamaño del directorio de templates.

Parámetros: 

  • tenantId=<parámetro> ID del tenant que tenga el tamaño calculado.

Devoluciones:

  • Tamaño del directorio de templates del TOTVS Fluig Plataforma.
  • FAILURE: Se produjo un error al obtener el tamaño del directorio de templates del TOTVS Fluig Plataforma.

TemporaryDirSizeMonitor

Indica el tamaño del directorio temporario del servidor.

Devolución:

  • Tamaño del directorio temporario del servidor de aplicación.

VolumeDirSizeMonitor

Indica el tamaño del directorio de volumen.

Parámetros: 

  • tenantId=<parámetro> ID del tenant que tenga el tamaño calculado.

Devoluciones:

  • Tamaño del directorio de volumen del TOTVS Fluig Plataforma.
  • FAILURE: Se produjo un error al obtener el tamaño del directorio de volumen del TOTVS Fluig Plataforma.

 

Acceso REST

Para acceder los servicios vía interface REST existen dos formas:

Método URL Explicación
GET http://<host>/monitor/report Devuelve el informe consolidado de todos los monitores, sin uso de parámetros.
GET http://<host>/monitor/report/<service_name>[?<parameter_name>]

Devuelve el informe a un servicio específico. Para esta llamada es posible enviar query parameters.

Consideraciones Generales:

  • <service_name> = Nombre del servicio sin el sufijo Monitor y con la primera letra minúscula. Ejemplo: Monitor TemporaryDirSizeMonitor > temporaryDirSize.
  • <parameter_name> = Nombre del parámetro para el servicio y su valor. Ejemplo: http://<host>/monitor/report/volumeDirSize?tenantId=2.
  • En el caso que un parámetro se envíe a un monitor que no posea parámetros, o este falle a la hora de generar su informe por algún motivo, devolverá el valor "UNKNOWN".
  • Los rendimientos siempre son Strings.
Figura 1: Ejemplo de consulta consolidada.
Figura 2: Ejemplo de consulta parametrizada.

Acceso JMX

Para acceder los monitores vía JMX se utiliza la siguiente interfaz:

@MXBean
public interface FluigServiceMonitor {
    /**
     * 
     * Generates the report for this monitor with given parameters. The parameter syntax is:
     * 
     * paramenterName1=value1 parameterName2=value2
     * 
     * Example: "tenantId=10 forceSearch=true maxResults=15"
     * 
     * @param parameter for the monitor report
     * @return report result
     * @throws UnsupportedOperationException if this monitor doesn't support parameters.
     */
    String report(String parameter) throws UnsupportedOperationException;
    /**
     * Generates the report for this monitor.
     * 
     * @return report result.
     */
    String report();
    /**
     * Returns the name of this monitor, usually the class name without the "Monitor" suffix
     * 
     * @return name of this monitor.
     */
    String getName();
}

Los MXBeans se registran con el siguiente nombre en la misma JVM del servidor de aplicaciones:

com.fluig.monitor.jmx.bean:type=<Nome do Monitor>

Ejemplo:

com.fluig.monitor.JMX.haba: tipo = ConnectedUsersMonitor

Con estas informaciones, simplemente acceda los JMXBeans, sin precisar utilizar una biblioteca externa con la interfaz. Como las devoluciones y parámetros son OpenTypes (Strings), no es necesario ninguna dependencia externa.

 

Figura 3: Ejemplo de acceso a los JMX Beans a través del JConsole.

 

Parámetros: 

  • jmxPort=<parámetro> Puerta de acceso JMX.

    Nota

    Icon

    Por estándar, la puerta de acceso JMX es 9999.

Devoluciones: