Configuración de Bizagi Diagnostics

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Administración del Sistema Bizagi > Mantenimiento y administración > Monitoreo > Herramienta de Diagnóstico de Bizagi >

Configuración de Bizagi Diagnostics

Introducción

Bizagi Diagnostics es una herramienta de diagnóstico presentada por Bizagi Ltd para proveer opciones de monitoreo en las operaciones de Bizagi Engine, para un ambiente de pruebas o de producción, como se describe en Herramienta de Diagnóstico de Bizagi.

La siguiente sección ilustra los prerequisitos de su instalación al igual que la información sobre cómo configurarla.

 

Prerrequisitos

Asegúrese de cumplir con los requerimientos de software y de hardware antes de instalar y utilizar Bizagi Diagnostics.

 

PRERREQUISITO

LO QUE SE NECESITA

INFORMACIÓN ADICIONAL

Java (JRE) de Oracle.

Java Runtime Environment instalado donde Bizagi Diagnostics se ejecuta.

Asegúrese de utilizar la versión 8, actualización 71 o superior.

Podrá revisar si cuenta con la versión adecuada del Java JRE instalada, usando una consola de comando e ingresando:

java -version

 

JAVA_version

 

Podrá descargar el Java JRE desde el sitio oficial de Oracle en:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

JAVA_HOME

configurado como variable de entorno.

Podrá revisar la configuración adecuada de esta variable de entorno, utilizando una consola de comando e ingresando (a lo cuál debe salir la ruta apropiada):

echo %JAVA_HOME%

 

JAVAHOME_env_Var

Microsoft .NET framework.

Framework de .NET 4.5 (o superior) instalado donde Bizagi Diagnostics se ejecuta.

Podrá descargar el framework de .NET de Microsoft, version 4.5, directamente desde el sitio oficial en:

http://go.microsoft.com/fwlink/?LinkId=395269

 

Asegúrese de habilitar el componente ASP.NET 4.5 dentro de las características del framework de .NET 4.5.

Características del Framework de .NET 3.5 (habilitadas aún cuando se cuente con framework 4.5)

Asegúrese de habilitar las características del framework de .NET 3.5 también, las cuales incluyen el soporte a características del framework 2.0 y 3.0.

Microsoft Internet Information Services.

Un IIS operacional que albergue la aplicación web Bizagi Diagnostic.

Versiones soportadas del IIS son: 6, 7, 7.5, 8, o 8.5.

Asegúrese de contar con un IIS soportado, según su sistema operativo Windows (p.e, Windows server 2008 R2, 2012 R2).

IIS con el rol habilitado de:

IIS 6 Management Compatibility.

Asegúrese de habilitar estos roles para la característica de servidor web del IIS, como se enseña a continuación:

 

IIS6_mgmt_compat

 

A configured base site at the IIS to host the Bizagi Diagnostics web application.

You may use the Default web site provided by the IIS:

 

IIS_default_website

Un pool de aplicaciones en el IIS que utilice el frameowk versión 4.0 de .NET, y que habilite aplicaciones en modo 32 bits con modo integrado del manejo de pipelines.

Usted deberá crear un pool de aplicación dedicado para el uso especial de Bizagi Diagnostics:

 

IIS_app_pool

 

Además de lo anterior, nótese que Bizagi Diagnostics requiere por lo menos de 360MB de espacio libre:

 

Prereq_diskspace

 

 

Instalando Bizagi Diagnostics

Para instalar Bizagi Diagnostics, asegúrese de ejecutar setup.exe con permisos de administrador local:

 

Diagnostics_install1

 

Dé clic en Siguiente (Next) en la pantalla inicial de bienvenida.

 

Seleccione la ubicación de la instalación especificando:

Site: El sitio base en el IIS que albergará la aplicación web de Bizagi Diagnostics (p.e, Default web site), como se menciona en la sección de prerrequisitos anterior.

Virtual directory: El nombre del sitio web y directorio virtual, el cuál tendrá los contenidos de la aplicación web de Bizagi Diagnostics. Será creada como una carpeta en la ruta del sitio base en el IIS base (p.e,, C:\inetpub\wwwroot\Bizagi.Diagnostics.Web\).

Application pool:  El pool de aplicaciones en el IIS que será usado por la aplicación web de Bizagi Diagnostics, como se menciona en la sección de prerrequisitos anterior.

 

Diagnostics_install2

 

Dé clic en Siguiente (Next) al finalizar con la configuración.

 

Configure la ruta de donde Bizagi Diagnostics visualizará la información de logs.

En esta ruta, asegúrese que Bizagi Engine esté creando los logs correspondientes.

Cómo realizar esta parte, es especificado en la sección acerca de Configurando Bizagi Diagnostics.

 

note_pin

Al definir esta ruta, considere:

 

Esta ruta puede ser un archivo local que sea compartido con todos los servidores de Bizagi Engine.

Esto se debe a que para la configuración de Bizagi Engine en un esquema de alta disponibilidad (p.e, uso de clústers), usted contará con más de un servidor de Bizagi Engine constantemente escribiendo archivos en este repositorio.

Al utilizar dicha configuración, usted deberá asegurarse que esta carpeta pueda accederse como una ruta UNC por las diferentes instancias de Bizagi Engine (p.e, accesible como \\Servidor\Ruta\), incluyendo los permisos adecuados para la cuenta de servicio de cada Bizagi Engine.

 

Diagnostics_install3

 

Dé click en Siguiente (Next) y confirme la instalación al dar clic en Siguiente de nuevo.

El procedimiento completo puede tardar un par de minutos.

 

Diagnostics_install4

 

Dé clic en Cerrar (Close) al finalizar.

 

Diagnostics_install5

 

En este punto, la instalación se encuentra completa y usted debería verificar que la aplicación web de Bizagi Diagnostics website haya sido creada en su sitio base del IIS:

 

Diagnostics_install6

 

note_pin

Servicios adicionales se instalan por defecto utilizando el puerto HTTP número 9200, como por ejemplo Elastic search.

 

Configurando Bizagi Diagnostics

Una vez que haya instalado Bizagi Diagnostics, la aplicación web permanece activa.

Sin embargo, usted deberá igualmente llevar a cabo ciertos aspectos de configuración para asegurarse que los logs de Bizagi Engine registren el detalle necesario para Bizagi Diagnostic.

 

Para hacerlo, primero edite el archivo de configuración de cada componente de Bizagi Engine (Portal de trabajo y servicio Programador) de cada servidor en caso de utilizar un clúster.

A través de esta configuración, usted define de manera explícita el detalle que se registra y en qué repositorio se hace.

 

Proceda editando el archivo web.config del Portal de trabajo (por defecto ubicado en C:\Bizagi\Projects\[su_proyecto]\WebApplication) para cada nodo de manera que se incluyen las siguientes 2 líneas dentro del elemento <appSettings>:

 

<add key="DiagnosticsEnabled" value="true"/>

<add key="DiagnosticsStorageName" value="[ruta_lectura_Diagnostics]\[prefijo_instancia]"/>

 

Diagnostics_config1

 

Considere reemplazar:

[ruta_lectura_Diagnostics]: Especifique el nombre de la carpeta que tiene pre-configurada para almacenar los logs que leerá Bizagi Diagnostics (durante la instalación deberá referenciar esta ubicación).

Recuerde que para el acceso desde Bizagi Engine, usted podrá utilizar una ruta tipo UNC (p.e, \\Servidor\Ruta\).

[prefijo_instancia]: Esta definición no representa una sub-carpeta sino un prefijo que se incluye para definir una marca para cada componente que registra logs en dicha ruta. De esta manera, los logs que leerá Bizagi Diagnostics conocerá el componente del cuál provienen.

Usted podrá utilizar por ejemplo W01 para el Portal de trabajo del nodo #1 en una arquitectura con clúster, y W02 para el nodo #2 (y así sucesivamente). De manera similar, usted podrá utilizar S01 para el servicio Programador del nodo #1, igualmente en clúster, usando S02 para el nodo #2, y así sucesivamente.

Además de lo anterior, nótese que DiagnosticsEnabled determina si los logs quedan activos para ese componente (los valores posibles son verdadero -true- o falso -false-).

 

Guarde los cambios al finalizar.

Este tipo de cambios no requiere que reinicie el servicio.

 

De manera similar, continue editando el archivo de configuración del Programador, llamado BizAgi.Scheduler.Services.exe.config y que se ubica por defecto en C:\Bizagi\Projects\[su_proyecto]\Scheduler.

Realice esto para cada nodo, de manera que se incluyen las mismas líneas anteriores dentro del elemento <appSettings> además de la llave <add key="RaiseSettingsService" value="false"/>, configurando sus valores al igual que como se describió anteriormente.

 

Las llaves para el servicio Programador son las siguientes:

<add key="DiagnosticsEnabled" value="true"/>

<add key="DiagnosticsStorageName" value="[Diagnostics_readFrom_path]\[instance_prefix]"/>

<add key="RaiseSettingsService" value="false"/>

 

Al finalizar, el archivo de configuración del Programador se verá como se ilustra en esta imagen:

 

Diagnostics_config2

 

Guarde los cambios al finalizar.

Los cambios en este archivo, requieren que reinicie el servicio del Programador (p.e desde el panel de servicios de Windows).

El reinicio del Programador toma unos segundos y no interrumpe las operaciones de Bizagi Engine.

 

En este punto, Bizagi Diagnostics ha sido configurado y podrá comenzar a usarlo como se describe en Uso de Bizagi Diagnostics.

 

note_pin

Para consultar todas las opciones disponibles para utilizar otras posibilidades en cuanto al repositorio que se usa para almacenar los eventos, consulte Opciones avanzadas para registrar los eventos de servidor.

 

Resolución de problemas

Bizagi Diagnostics se apoya en servicios adicionales como lo son ElasticSearch y LogStash.

Una operación exitosa de Bizagi Diagnostics podrá verificar la correcta ejecución del monitor de Elastic Search que se visualiza desde http://localhost:9200/_plugin/HQ.

 

El servicio de Bizagi Diagnostics automáticamente inicia, reinicia y monitorea estos otros servicios. Esto significa que el servicio de Bizagi Diagnostic se debe encontrar siempre iniciado y bajo ejecución (verificable desde el panel de servicios de Windows).

 

Diagnostics_troubleshooting

 

En caso de que este servicio no se inicie automáticamente para a su vez inicializar los otros servicios, entonces usted podrá iniciar estos otros de manera manual desde sus archivos .bat respectivos (y revisar sus archivos de configuración .config):

ElasticSearch: Su ejecutable está disponible en C:\BizagiDiagnosticsTool\ELK\elasticsearch\bin\elasticsearch.bat.

LogStash: Su ejecutable está disponible en C:\BizagiDiagnosticsTool\ELK\logstash\bin\logstash.bat, el cuál debe ser lanzado usando el comandologstash -f logstash.conf