Configurar un adaptador para la supervisión de la aplicación en tiempo real

El Adaptador de anotaciones genérico proporciona una clase de productor que permite que los objetos de suceso base común que genera el adaptador se envíen a un agente de anotaciones. Se puede utilizar el Analizador de anotaciones y rastreo para conectar al agente de anotaciones, lo que permite supervisar y analizar las anotaciones de aplicación en tiempo real.

Requisitos previos:

Para configurar el adaptador para la supervisión, siga los pasos que se indican a continuación:

Configurar el componente productor

Nota: Cuando se crea un nuevo archivo de configuración del adaptador, se configura para utilizar la clase CBELogOutputter por omisión. Si no ha cambiado este valor, puede saltarse este procedimiento.

El componente productor del archivo de configuración del adaptador se debe actualizar para utilizar la clase CBELogOutputter que escribe los objetos de suceso base común en un agente de anotaciones. Puede actualizar el componente productor existente, o bien, añadir un nuevo componente productor.

Para añadir un nuevo componente productor:

  1. Para editar el archivo de configuración del adaptador, seleccione el archivo de configuración del adaptador en el panel Navegador. Pulse el botón derecho del ratón y seleccione Abrir con > Editor de configuraciones de adaptador. El archivo se abre en el editor.
  2. En la ventana Editor de configuraciones de adaptador, expanda el nodo Adaptador > Configuración > Instancia de contexto.
  3. Pulse el botón derecho del ratón sobre la Instancia de contexto y seleccione Añadir > Productor. Se crea un nuevo productor en la Instancia de contexto.
  4. En el campo Tipo de productor, seleccione LoggingAgentOutputter.
  5. Pulse la propiedad agentName. Los detalles de la propiedad se muestran en el panel situado a la derecha.
  6. Actualice el valor de la propiedad con el nombre del agente de anotaciones que desea. Éste es el nombre que se muestra en el Analizador de anotaciones y rastreo como Agente de anotaciones que se va a supervisar.
  7. Si desea que el productor espere antes de escribir sucesos base comunes en el agente de anotaciones, añada la propiedad denominada waitUntilLoggingTime y establezca el valor de la propiedad para el tiempo en milisegundos. Para añadir la propiedad, pulse el botón derecho del ratón sobre el productor que acaba de crear y seleccione Añadir > Propiedad. Se crea una nueva propiedad en el nuevo nodo Productor.
  8. Para habilitar la clase CBELogOutputter, debe crear el componente producto asociado en la Implementación de contexto básica de contextos. Abra Contextos > Contexto de implementación básica de contexto.
  9. Pulse el botón derecho del ratón sobre Contexto de implementación básica de contexto y seleccione Añadir > Componente. Se añade un nuevo componente al contexto.
  10. Configure el nuevo componente con los valores siguientes:
    Nombre: Nombre del productor en el contexto
    Descripción: Descripción de lo que hace el productor
    Clase ejecutable: org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    Nivel de anotacionesNivel de anotaciones internas que debe utilizar el componente productor.
    Un valor de 99 significa que el productor no va a anotar ningún mensaje.
    Un valor de 0 significa que el productor va a anotar mensajes de todos los niveles de gravedad.
    El valor que se recomienda es 50, puesto que significa que sólo se van a anotar los mensajes de error del productor internos Críticos y Muy graves.
    Rol: Productor
    ID exclusivo: Debe señalar al productor que se ha definido en la Instancia de contexto en el paso 3. Utilice el botón Examinar para seleccionar el ID correcto.
  11. Guarde los cambios del archivo de configuración del adaptador.

Configurar la instancia de contexto

Si desea que el analizador de anotaciones supervise el archivo de anotaciones de forma continua, debe actualizar las propiedades de la instancia de contexto del archivo de configuración del adaptador para la operación continua.

  1. Para editar el archivo de configuración del adaptador, seleccione el archivo de configuración del adaptador en la perspectiva Navegador. Pulse el botón derecho del ratón y seleccione Abrir con > Editor de configuraciones de adaptador. El archivo se abre en el editor.
  2. En la ventana del editor, seleccione Adaptador > Configuración > Instancia de contexto. Los detalles de la instancia de contexto se muestran en el panel situado a la derecha.
  3. Seleccione el recuadro de selección Operación continua.
  4. Configure los campos Tiempo máximo desocupado e Intervalo de pausa según proceda.
  5. Guarde los cambios del archivo de configuración del adaptador.

Iniciar un proceso Java para ejecutar el adaptador

El adaptador de anotaciones que ha creado se puede ejecutar de forma externa desde un archivo de proceso por lotes en el entorno Windows, o bien, en un script de shell en entornos que no son de Windows. Más abajo se incluyen archivos de ejemplo que se pueden utilizar para iniciar el proceso Java que va a ejecutar el adaptador de anotaciones.
Nota: Para conectar y supervisar el agente de anotaciones que ha creado el Adaptador de anotaciones genérico, se debe instalar un controlador de agentes Hyades en el sistema en el que se va a ejecutar el Adaptador de anotaciones genérico, y se debe iniciar antes de iniciar el Adaptador de anotaciones genérico.

Archivo de proceso por lotes de Windows:

@rem USAGE: runregex 
@rem PURPOSE: Illustrates the functional capabilities of the Generic Log Adapter (GLA) 
@rem run-time using an example adapter file and sample log file. 
@rem ASSUMPTIONS: This batch file assumes the GLA run-time and required files are 
@rem stored in the following directory structure: 
@rem %GLA_HOME%\config - GLA adapter configuration files 
@rem %GLA_HOME%\lib - GLA run-time and required jars 
@rem %GLA_HOME%\schema - GLA adapter configuration schema files 
@rem INSTRUCTIONS: 
@rem If the GLA run-time and required files are stored as indicated in the 
@rem assumptions section above, change the value of the %GLA_HOME% 
@rem environment variable to the absolute path where the GLA run-time 
@rem and required files are stored. 
@rem If the GLA run-time files are stored in a plug-in (e.g. Eclipse) 
@rem environment, perform the following instructions: 
@rem 1) Create a temporary directory to store the GLA run-time and required files. 
@rem 2) Create the config, lib, and schema directories in the temporary 
@rem directory creatd in step 1) 
@rem 3) Change the value of the %GLA_HOME% environment variable to the 
@rem absolute path of the temporary directory created in step 1) 
@rem 4) Copy the adapter files you want to run into the %GLA_HOME%\config directory.
@rem For example if you want to run the Apache adapter files then copy the
@rem Apache directory of the org.eclipse.hyades.logging.adapter.config
@rem plug-in and all of its contents to the %GLA_HOME%\config directory.
@rem 5) Copy the contents of the schema directory of
@rem org.eclipse.hyades.logging.adapter plug-in to the %GLA_HOME%\schema directory.
@rem 6) Copy the following jar files to the %GLA_HOME%\lib directory
@rem Plug-in | JAR
@rem ---------------------------------------------------
@rem org.eclipse.hyades.logging.adapter | hgla.jar
@rem org.eclipse.hyades.logging.core | hlcbe101.jar
@rem org.eclipse.hyades.logging.core | hlcore.jar
@rem org.eclipse.hyades.execution.remote | hexr.jar
@rem org.eclipse.emf.ecore | ecore.jar
@rem org.eclipse.emf.common | common.jar

SET GLA_HOME=d:\GenericLogAdapter 
SET CONFIG_FILE=%GLA_HOME%\config\my.adapter 
@PUSHD %GLA_HOME%\config\ 
java -DGLA_HOME="%GLA_HOME%" -classpath "%GLA_HOME%\lib\hgla.jar;%GLA_HOME%\lib\hexr.jar;%GLA_HOME%\lib\hlcbe101.jar;%GLA_HOME%\lib\ecore.jar;%GLA_HOME%\lib\common.jar;%GLA_HOME%\lib\hlcore.jar" org.eclipse.hyades.logging.adapter.Adapter -ac "%CONFIG_FILE%" -cc "%CONFIG_FILE%"
POPD


Archivo de proceso por lotes que no es de Windows:
#!/bin/sh 
# USAGE: runregex.sh 
# PURPOSE: Illustrates the functional capabilities of the Generic Log Adapter (GLA) 
# run-time using an example adapter file and sample log file. 
# ASSUMPTIONS: This shell file assumes the GLA run-time and required files are 
# stored in the following directory structure: 
# %GLA_HOME%/config - GLA adapter configuration files 
# %GLA_HOME%/lib - GLA run-time and required jars 
# %GLA_HOME%/schema - GLA adapter configuration schema files 
# INSTRUCTIONS: 
# If the GLA run-time and required files are stored as indicated in the 
# assumptions section above, change the value of the %GLA_HOME% 
# environment variable to the absolute path where the GLA run-time 
# and required files are stored. 
# If the GLA run-time files are stored in a plug-in (e.g. Eclipse) 
# environment, perform the following instructions: 
# 1) Create a temporary directory to store the GLA run-time and required files. 
# 2) Create the config, lib, and schema directories in the temporary 
# directory creatd in step 1) 
# 3) Change the value of the %GLA_HOME% environment variable to the 
# absolute path of the temporary directory created in step 1) 
# 4) Copy the adapter files you want to run to the %GLA_HOME%/config directory. 
# For example, if you want to run the Apache adapter files then copy the 
# Apache directory of the org.eclipse.hyades.logging.adapter.config 
# plug-in and all of its contents to the %GLA_HOME%/config directory. 
# 5) Copy the contents of the schema directory of 
# org.eclipse.hyades.logging.adapter plug-in to the %GLA_HOME%/schema directory. 
# 6) Copy the following jar files to the %GLA_HOME%/lib directory 
# Plug-in | JAR 
# --------------------------------------------------- 
# org.eclipse.hyades.logging.adapter | hgla.jar 
# org.eclipse.hyades.logging.core | hlcbe101.jar 
# org.eclipse.hyades.logging.core | hlcore.jar 
# org.eclipse.hyades.execution.remote | hexr.jar
# org.eclipse.emf.ecore | ecore.jar 
# org.eclipse.emf.common | common.jar

GLA_HOME=/home/eclipse/GenericLogAdapter 
export GLA_HOME 

CONFIG_FILE="$GLA_HOME/config/my.adapter" 
export CONFIG_FILE 

CUR_DIR=`pwd` 
export CUR_DIR 

cd "$GLA_HOME/config" 

java -DGLA_HOME="$GLA_HOME" -classpath "$GLA_HOME/lib/hgla.jar:$GLA_HOME/lib/hexr.jar:$GLA_HOME/lib/hlcbe101.jar:$GLA_HOME/lib/ecore.jar:$GLA_HOME/lib/common.jar:$GLA_HOME/lib/hlcore.jar" org.eclipse.hyades.logging.adapter.Adapter -ac "$CONFIG_FILE" -cc "$CONFIG_FILE" 

cd "$CUR_DIR"
Configure el archivo según proceda para iniciar el proceso Java que va a ejecutar el adaptador.

Supervisar las anotaciones de aplicación en tiempo real

Ahora ya está preparado para supervisar las anotaciones de aplicación en tiempo real.

  1. Asegúrese de que las anotaciones están habilitadas en las preferencias.
    1. En la barra de herramientas principal, seleccione Ventana > Preferencias. Se abre el asistente de Preferencias.
    2. Seleccione Perfilado y anotaciones en el panel situado a la izquierda. Las preferencias de Perfilado y anotaciones se cargan en el panel situado a la derecha.
    3. Seleccione Habilitar anotaciones en las opciones de Perfilado y anotaciones.

      El recuadro de selección Habilitar anotaciones se muestra seleccionado en el panel de preferencias de Perfilado y anotaciones

    4. Seleccione Aceptar para aplicar los cambios.
  2. En la perspectiva Perfilado y anotaciones, pulse la barra de herramientas de Perfilado Icono de la barra de herramientas de perfilado y seleccione Perfilar. Se abre el asistente de perfilado.
  3. Seleccione Conectar - Proceso Java y pulse el botón Nuevo, que se encuentra en la parte inferior de la lista. Se crea una nueva configuración de proceso Java.
  4. Pulse la pestaña Sistemas principales y seleccione el sistema principal en el que residen las anotaciones de la aplicación.
    Nota: Para supervisar las anotaciones de una aplicación en tiempo real, el controlador de agentes debe estar en ejecución en el mismo sistema que la aplicación.
  5. Pulse la pestaña Agentes y utilice las teclas de flecha para seleccionar el agente de anotaciones que ha configurado.

    En el asistente de preferencias de perfilado, el agente de anotaciones que ha creado el usuario se muestra en la panel situado a la izquierda

  6. Pulse Aplicar.
  7. Pulse Perfilar para conectar al agente de anotaciones.
  8. En la perspectiva Perfilado y anotaciones de la vista Monitor de perfilado, seleccione el agente de anotaciones.
  9. Pulse el botón derecho del ratón sobre el agente y seleccione Iniciar supervisión.
  10. Pulse el botón derecho del ratón sobre el agente y seleccione Abrir con > Vista Anotaciones. Los sucesos de anotaciones de las anotaciones de la aplicación se cargan en la vista Anotaciones.
    Nota: Si no desea ver ningún registro de anotaciones en la vista Anotaciones, pulse el botón Renovar vistas, que se encuentra en la parte superior del panel Monitor de perfilado.

 

Conceptos relacionados
Visión general del Adaptador de anotaciones genérico
Especificación del formato de suceso base común

Tareas relacionadas
Crear un analizador de anotaciones

Consultas relacionadas
Estructura del archivo de configuración del adaptador
Editor de configuraciones de adaptador
Gramática de las expresiones regulares