Configuración de un adaptador para supervisión de aplicaciones en tiempo real

El Adaptador genérico de anotaciones proporciona una clase Outputter que permite enviar los objetos Suceso base común generados por su adaptador a un Agente de anotación. El Analizador de rastreo y anotaciones se puede utilizar para la conexión al Agente de anotación, para supervisar y analizar las anotaciones de la aplicación en tiempo real.

Requisitos previos:

Siga estos pasos para configurar el adaptador para supervisión.

Configurar el componente Outputter

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

El componente Outputter del archivo de configuración del adaptador se debe actualizar para que utilice la clase CBELogOutputter que graba los objetos Suceso base común en un Agente de anotaciones. Se puede actualizar el componente Outputter existente o añadir un componente Outputter nuevo.

Para añadir un componente Outputter nuevo:

  1. Para editar el archivo de configuración del adaptador, selecciónelo en el panel Navegador. Pulse el botón derecho del ratón y seleccione Abrir con > Editor de configuración de adaptador. El archivo se abre en el editor.
  2. En la ventana Editor de configuración del adaptador, acceda al nodo Adaptador > Configuración > Instancia de contexto.
  3. Pulse el botón derecho del ratón en la Instancia de contexto y selecciones Añadir > Outputter. En la Instancia de contexto se crea un Outputter nuevo.
  4. En el campo Tipo de Outputter, seleccione LoggingAgentOutputter.
  5. Pulse en la propiedad agentName. Los detalles de propiedades se muestran en el panel de la derecha.
  6. Actualice el valor de la propiedad con el nombre de Agente de anotación que quiera. Es el nombre que se verá en el Analizador de rastreo y anotaciones como Agente de anotaciones a supervisar.
  7. Si quiere que el Outputter espere antes de grabar los Sucesos base comunes en el Agente de anotaciones, añada una propiedad denominada waitUntilLoggingTime y establezca el valor de la propiedad en el tiempo deseado (en milisegundos). Para añadir la propiedad, pulse el botón derecho del ratón sobre el Outputter recién creado y seleccione Añadir > Propiedad. Se creará una propiedad nueva en el nuevo nodo Outputter.
  8. Para habilitar la clase CBELogOutputter, es necesario crear el componente Outputter asociado en la Implementación de contexto básica de contextos. Abra Contextos > Contexto de implementación básica de contextos.
  9. Pulse el botón derecho del ratón sobre Contexto de implementación básica de contextos y seleccione Añadir > Componente. Se añadirá un componente nuevo al contexto.
  10. Configure el componente nuevo con los valores siguientes:
    Nombre: Nombre del Outputter en el contexto. Por ejemplo, Outputter de agente de anotaciones
    Descripción: Descripción de lo que hace este Outputter
    Clase ejecutable: org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    Nivel de anotación:Nivel de la anotación interna que el componente Outputter debe utilizar. Este nivel está basado en los niveles de anotación de CommonBaseEvent. Cuando mayor es el número, más imporante es el mensaje. Para el nivel de anotación, el número que se especifique hará que el componente Outputter sólo anote los mensajes internos del Outputter de la gravedad especificada y superiores. El valor 71 o superior indicaría que Outputter no anote mensajes internos del Outputter. El valor 0 indicaría que Outputter anotaría todos los mensajes internos del Outputter. El valor recomendado es 50, lo que establece que sólo se anotan los mensajes de error críticos o muy graves internos del Outputter.
    Cometido: Outputter
    Id. exclusivo: Debe apuntar al Outputter definido en la Instancia de contexto del 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 quiere que el analizador de anotaciones supervise el archivo de anotaciones de forma continua, hay que actualizar las propiedades de instancia de contexto del archivo de configuración del adaptador para que funcione continuamente.

  1. Para editar el archivo de configuración del adaptador, selecciónelo en la perspectiva Navegador. Pulse el botón derecho del ratón y seleccione Abrir con > Editor de configuración 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 visualizan en el panel de la derecha.
  3. Marque el recuadro de selección Operación continua.
  4. Configure los campos Tiempo máximo de inactividad e Intervalo de pausa, según sus necesidades.
  5. Guarde los cambios del archivo de configuración del adaptador.

Lanzar un proceso Java para que ejecute el adaptador

El analizador de anotaciones creado se puede ejecutar de forma externa desde un archivo por lotes en el entorno de Windows o en un script de shell en entornos que no sean Windows. A continuación se muestran archivos de ejemplo que se pueden utilizar para lanzar el proceso Java que ejecutará el adaptador de anotaciones.
Nota: Para conectar y supervisar el agente de anotaciones creado por el Adaptador de anotaciones genérico, Agent Controller debe estar instalado en el sistema en que se ejecutará el Adaptador genérico de anotaciones y se debe iniciar antes de iniciar el Adaptador genérico de anotaciones.

Archivo por lotes de Windows:

@rem USO:  runregex
@rem OBJETIVO: Muestra las posibilidades funcionales en tiempo de ejecución del Analizador genérico de anotaciones (GLA) utilizando un archivo adaptador y un archivo de anotaciones de ejemplo.
@rem INSTRUCCIONES: Cuando se ejecuta en un entorno de ejecución de GLA, hay que cambiar el valor de la variable de entorno %GLA_HOME% por la vía de acceso absoluta del la ubicación del tiempo de ejecución GLA descomprimido.
@rem NOTA:  Cuando se ejecuta en un entorno de ejecución de conector (p.e. Eclipse), hay que crear un directorio de trabajo temporal y cambiar el valor de la variable de entorno %GLA_HOME%
@rem        por la vía de acceso absoluta del nuevo directorio de trabajo temporal. Además, hay que crear el directorio %GLA_HOME%\config y copiar el contenido del conector org.eclipse.hyades.logging.adapter.config
@rem        en el nuevo directorio %GLA_HOME%\config. Por último, hay que crear un directorio %GLA_HOME%\lib y copiar los archivos JAR siguientes en el directorio %GLA_HOME%\lib nuevo:
@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 MY_DIRECTORY=MyAdapter
SET CONFIG_FILE=%GLA_HOME%\config\%MY_DIRECTORY%\myadapter.adapter
PUSHD %GLA_HOME%\config\%MY_DIRECTORY%\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 por lotes para entornos que no son Windows:
#!/bin/sh
# USO:    runregex_example.sh
# OBJETIVO: Muestra las posibilidades funcionales en tiempo de ejecución del Analizador genérico de anotaciones (GLA) utilizando un archivo adaptador y un archivo de anotaciones de ejemplo.
# INSTRUCCIONES: Cuando se ejecuta en un entorno de ejecución de GLA, hay que cambiar el valor de la variable de entorno $GLA_HOME por la vía de acceso absoluta del la ubicación del tiempo de ejecución GLA descomprimido.
# NOTA:  Cuando se ejecuta en un entorno de ejecución de conector (p.e. Eclipse), hay que crear un directorio de trabajo temporal y cambiar el valor de la variable de entorno $GLA_HOME
#        por la vía de acceso absoluta del nuevo directorio de trabajo temporal. Además, hay que crear el directorio $GLA_HOME/config y copiar el contenido del conector com.ibm.etools.logging.adapter.config
#        en el nuevo directorio $GLA_HOME/config. Por último, hay que crear un directorio $GLA_HOME/lib y copiar los archivos JAR siguientes en el directorio $GLA_HOME/lib nuevo:
#               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

YOUR_DIRECTORY=MY_DIRECTORY
export MY_DIRECTORY

CONFIG_FILE="$GLA_HOME/config/$MY_DIRECTORY/myadapter.adapter"
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd "$GLA_HOME/config/$MY_DIRECTORY

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 sea necesario para lanzar el proceso Java que ejecutará su adaptador.

Supervisión en tiempo real de las anotaciones de la aplicación

Ya está preparado para supervisar las anotaciones de la aplicación en tiempo real.

  1. Asegúrese de que la anotación está habilitada en las preferencias.
    1. En la barra de herramientas principal, seleccione Ventana > Preferencias . Se abrirá el asistente Preferencias.
    2. Seleccione Perfilado y anotaciones en el panel de la izquierda. En el panel de la derecha se cargarán las preferencias de Perfilado y anotaciones.
    3. Seleccione Habilitar anotación en las opciones Perfilado y anotaciones.

      En el panel de preferencias Perfilado y anotaciones, el recuadro de selección Habilitar anotaciones está seleccionado

    4. Seleccione Aceptar para aplicar los cambios.
  2. En la perspectiva Perfilado y anotaciones, pulse Perfilado Icono de la herramienta de perfilado en la barra de herramientas y seleccione Perfil. Se abrirá el asistente Perfil.
  3. Seleccione Conectar - Proceso Java y pulse el botón Nuevo que se encuentra en parte inferior de la lista. Se crea una configuración de proceso Java nueva.
  4. Pulse la ficha Sistemas principales y seleccione el sistema principal en que se encuentra la anotación de la aplicación, desplazándolo al panel Agentes seleccionados con el botón de flecha.
    Nota: Para supervisar anotaciones de aplicación en tiempo real, se debe ejecutar Agent Controller en el mismo sistema que la aplicación.
  5. Pulse la ficha Agentes y utilice las flechas para seleccionar el Agente de anotaciones que ha configurado.

    En el asistente Preferencias de perfilado, el agente de anotaciones creado por el usuario se encuentra en el panel de la izquierda

  6. Pulse Aplicar.
  7. Pulse Perfil para conectarlo al Agente de anotaciones.
  8. En la vista Supervisor de perfilado de la perspectiva Perfilado y anotaciones, seleccione Agente de perfilado.
  9. Pulse el botón derecho del ratón sobre Agente de perfilado y seleccione Iniciar supervisión.
  10. Pulse el botón derecho del ratón sobre Agente de perfilado y seleccione Abrir con > Visor de anotaciones. Los sucesos de anotación de las anotaciones de la aplicación se cargan en la vista Anotaciones.

 

Conceptos relacionados
Visión general de Hyades Generic Log Adapter
Especificación del formato de Suceso de base común

Tareas relacionadas
Creación de un analizador de anotaciones

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