DMReMon Monitor de Recursos Multiplataforma con entorno de desarrollo

Manual de instalación, usuario y desarrollo

• Manual de instalación de la aplicación

  La aplicación se distribuye en dos ficheros tar.gz diferentes. Estos dos ficheros son:

  • DMReMon-1.0.tar.gz: Este archivo contiene tanto la versión standalone de la aplicación como la parte servidora de la misma. El contenido de este archivo (una vez descomprimido) es el siguiente:
    • DMReMon/bin/: Este directorio contiene las clases compiladas (los bytecodes en Java) y los recursos usados por dichas clases como son los archivos .xsl utilizados cuando se exporta a XML/HTML y las imágenes que se muestran en la GUI.
    • DMReMon/conf/: Este directorio contiene los archivos de configuración de la aplicación. Estos ficheros son:
      • configuracion.xml y configuracion.dtd: Fichero de configuración de los parámetros de la aplicación y su correspondiente DTD.
      • componentes_en.xml, componentes_es.xml y componentes.dtd: Fichero que define los tipos de componentes de la aplicación (en inglés y castellano) y su correspondiente DTD.
      • logs_es.xml, logs_en.xml y logs.dtd: Fichero que define el tipo de componentes "Logs" (en inglés y castellano) y su correspondiente DTD.
      • plugins_en.xml, plugins_es.xml y plugins.dtd: Fichero que define el tipo de componentes "Plugins" (en inglés y castellano) y su correspondiente DTD.
      • recursos_en.xml, recursos_es.xml y recursos.dtd: Fichero que define el tipo de componentes "Recursos" (en inglés y castellano) y su correspondiente DTD.

      Este directorio también contiene un subdirectorio llamado bak en el que se guarda una copia de seguridad de todos estos ficheros de la aplicación, ya que estos ficheros pueden ser modificados en tiempo de ejecución.

    • DMReMon/doc/: Este directorio contiene la documentación de la aplicación, es decir, el presente documento (en formato pdf y Open Office). También contiene todas las imágenes usadas en dicho documento.
    • DMReMon/lib/: Este directorio contiene las librerías usadas por la aplicación. Las librerías con extensión .jar corresponden a los productos Axis y Log4J. Además contiene las librerías dinámicas que usa la aplicación para ejecutar los métodos nativos: linuxAPI.so para Linux y win32API.dll para Windows.
    • DMReMon/logs/: En este directorio se guardan los archivos donde la aplicación vuelva los logs.
    • DMReMon/properties/: Este directorio contiene los ficheros de propiedades necesarios para la aplicación. Estos ficheros son:
      • internacionalizacion_en.properties: Es el fichero que proporciona a la aplicación el idioma inglés.
      • internacionalizacion_es.properties: Es el fichero que proporciona a la aplicación el idioma español.
      • log.properties: Es el fichero de configuración de Log4J.
      • monitor.properties: Es el fichero de propiedades principal de la aplicación. Este fichero debe ser encontrado en tiempo de ejecución por la aplicación, por tanto, deberá estar en el classpath.
    • DMReMon/src/: Contiene el código fuente de la aplicación: código Java, código C, imágenes usadas en la aplicación, ficheros .xsl, etc.
    • DMReMon/temp/: Este directorio es, por defecto, el usado por la aplicación para exportar la información a XML/HTML.
    • DMReMon/build.xml: Es el fichero de configuración de Ant, que contiene las tareas necesarias para compilar, ejecutar la aplicación en modo standalone, desplegar la parte servidora de la aplicación en un contenedor de servlets, generar las librerías dinámicas de código nativo, etc.
    • DMReMon/DMReMon.bat: Este script permite ejecutar la aplicación en modo standalone en el sistema operativo Windows.
    • DMReMon/DMReMon.sh: Este script permite ejecutar la aplicación en modo standalone en el sistema operativo Linux.
  • DMReMonClient-1.0.tar.gz: El contenido de este archivo (una vez descomprimido) es el siguiente:
    • DMReMon/bin/: Este directorio contiene las clases compiladas y los recursos usados por dichas clases.
    • DMReMon/lib/: Este directorio contiene las librerías usadas por la aplicación. Estas librerías corresponden al producto Axis.
    • DMReMon/src/: Contiene el código fuente de la aplicación.
    • DMReMon/build.xml: Es el fichero de configuración de Ant, que contiene las tareas necesarias para compilar y ejecutar el cliente de la aplicación.
    • DMReMon/DMReMonClient.bat: Este script permite ejecutar el cliente de la aplicación en el sistema operativo Windows.
    • DMReMon/DMReMonClient.sh: Este script permite ejecutar el cliente de la aplicación en el sistema operativo Linux.

  Un paso previo a la instalación será el tener instalado una JVM en el sistema. Esto se debe a que la aplicación está escrita en Java y por tanto, será necesario disponer de una JVM para poder ejecutarla. Se recomienda usar la última versión 1.4.2 de J2RE o de J2SE, esta última para el caso de que se quiera utilizar la aplicación de forma distribuida, ya que es uno de los requisitos del Tomcat. Ambas herramientas pueden ser descargadas del sitio Web de Sun: http://java.sun.com. La versión utilizada para la realización del proyecto ha sido la 1.4.2_03 aunque con cualquier versión posterior debería funcionar sin problemas. También será necesario que el sistema tenga la variable de entorno JAVA_HOME apuntando al directorio de instalación del J2RE o J2SE.

  Además, en el caso de que queramos ejecutar la aplicación en una máquina Linux, hay que tener en cuenta que la aplicación sólo funciona con versiones de kernel 2.6.x.

  A continuación se explica la instalación de la aplicación en los dos modos en que funciona: modo standalone y modo distribuido.

  • Instalación de la aplicación standalone

    Los pasos para instalar la aplicación y poder usarla de forma standalone son los siguientes:

    1. Descomprimir el contenido del fichero DMReMon-1.0.tar.gz en un directorio.
    2. Modificar los archivos monitor.properties y log.properties. Dichos archivos definen una serie de rutas absolutas (una ruta cada fichero) que habrá que modificar dependiendo del directorio de instalación de la aplicación.
    3. En este punto ya podemos ejecutar la aplicación ejecutando los scripts correspondientes: DMReMon.sh para Linux o DMReMon.bat para Windows. Para que todo funcione correctamente, tendremos que ejecutar dichos scripts desde el directorio de instalación.
    4. Si queremos ejecutar la aplicación desde otro directorio tendremos que exportamos la variable de entorno DMREMON_HOME con el valor del directorio de instalación.

  • Instalación de la aplicación distribuida

    Como ya hemos comentado, la aplicación permite ejecutarse siguiendo el modelo cliente-servidor basado en servicios Web. Esto quiere decir que podremos ejecutar el servidor en una máquina y acceder a la información que proporciona el monitor desde un cliente instalado en otra máquina.

    Los pasos para la instalación de la aplicación distribuida, una vez que ya hemos instalado la aplicación standalone, son los siguientes:

    1. Instalación de Ant.
    2. Instalación de Tomcat.
    3. Instalación de Axis.
    4. Despliegue de la aplicación DMReMon.
    5. Instalación del cliente DMReMon.

    En los siguientes apartados describimos detalladamente cada uno de estos pasos. Hay que destacar que la instalación de Ant, Tomcat y Axis es válida tanto para Linux como para Windows, con las únicas diferencias de que en Windows al valor de una variable de entorno se accede con %VAR_ENTORNO%, en vez de con $VAR_ENTORNO (utilizado en Linux) y que las rutas en Windows utilizan el carácter '\' en vez de '/', que es el carácter usado en Linux.

    • Instalación de Ant

      El primer paso es descargar la distribución binaria de la herramienta Ant desde http://ant.apache.org. En el momento de la realización del proyecto la última versión estable de Ant es la 1.6.2 y es ésta la versión que se ha utilizado a lo largo del proyecto.

      Una vez descargada la herramienta (en el formato elegido de entre los disponibles: zip, tar.gz o tar.bz2) habrá que descomprimirla en el directorio deseado para su instalación. Una vez descomprimida, tendremos que añadir al path el directorio bin que está dentro del directorio raíz de la herramienta Ant.

      Para comprobar si la instalación se ha realizado correctamente, bastará con ejecutar el comando "ant -version" y deberemos obtener algo como lo siguiente:

      Apache Ant version 1.6.2 compiled on July 16 2004

    • Instalación de Tomcat

      Lo primero que necesitamos en este punto es obtener la versión adecuada del servidor Tomcat, la cual puede ser descargada desde http://jakarta.apache.org/tomcat. Actualmente, la última versión de Tomcat es la 5.5.7, pero puesto que sobre el Tomcat que instalemos habrá que instalar Axis, y Axis recomienda utilizar la última versión 4.x disponible de Tomcat, para la realización del presente proyecto se ha utilizado la versión 4.1.31.

      Una vez que hemos bajado la versión adecuada de Tomcat (la distribución binaria) procedemos a su instalación. Los pasos necesarios para la instalación son:

      1. Descomprimir el fichero descargado en el directorio que elijamos para la instalación.
      2. Crear la variable de entorno CATALINA_HOME con el valor del directorio donde hemos descomprimido el Tomcat.

      Ahora ya es posible arrancar el servidor Tomcat ejecutando los scripts incluidos en el directorio $CATALINA_HOME/bin: startup.sh para el caso de Linux o startup.bat para el caso de Windows.

      Para parar el Tomcat habrá que ejecutar el script de parada que se encuentra en el directorio $CATALINA_HOME/bin: shutdown.sh para el caso de Linux o shutdown.bat en el caso de Windows.

      El servidor Tomcat cuando está arrancado utiliza dos puertos TCP. Estos dos puertos son:

      • 8080: En este puerto escucha las peticiones que se hagan al Tomcat, por ejemplo cuando se introduce una URL en un navegador, cuando desde un servlet se invoca a otro servlet, etc.
      • 8005: En este puerto escucha las peticiones para parar el servidor. Cuando se invoca el script de parada (shutdown.sh o shutdown.bat) lo que se hace es mandar la cadena SHUTDOWN al puerto configurado para escuchar las peticiones de parada.

      Ambos puertos están definidos en el fichero $CATALINA_HOME/conf/server.xml y pueden ser modificados con los valores deseados.

      Por último hay que decir que, con la configuración que trae por defecto la distribución (en el fichero server.xml), el Tomcat instalado funcionará como un contenedor independiente.

    • Instalación de Axis

      Lo primero de todo será descargar la distribución binaria de Axis para Java desde http://ws.apache.org/axis. En el momento de la realización del proyecto, la última versión estable de Axis era la 1.1, pero puesto que el cliente desarrollado consume servicios Web de forma asíncrona, se ha necesitado una versión más nueva que incluyera esta funcionalidad. Por tanto, la versión utilizada en el proyecto ha sido la 1.2RC2.

      Una vez que hemos obtenido la distribución de Axis procedemos a su instalación [13]. Los pasos necesarios para la instalación son:

      1. Descomprimir el fichero descargado en el directorio que elijamos para la instalación.
      2. Crear la variable de entorno AXIS_HOME con el valor del directorio donde hemos descomprimido Axis.
      3. Hacer accesible Axis desde Tomcat. Axis está basado en servlets, por lo que se necesita de un contenedor de servlets para ejecutar. Esto se puede hacer de dos formas:
         • Copiando el directorio $AXIS_HOME/webappps/axis en el directorio $CATALINA_HOME/webapps.
         • Creando un nuevo contexto en el fichero de configuración del Tomcat (server.xml) para que Tomcat pueda ejecutar la aplicación Axis. Esta forma tiene la ventaja de que si actualizamos la versión de Axis no sería necesario volver a copiar la aplicación dentro del Tomcat, sino que sería suficiente que la nueva versión de Axis conservara la misma ruta definida en el contexto creado (o modificar esta ruta en dicho contexto si no ha sido posible mantener la misma ruta) para que todo funcionara correctamente. Además, si se actualiza la versión de Tomcat, tan sólo será necesario volver a crear el contexto en el fichero server.xml de la nueva versión de Tomcat. Un ejemplo de contexto para usar Axis puede ser el siguiente:

           <Context path="/axis"
             docBase="/home/agp/usr/local/axis/webapps/axis"
             debug="1"
             reloadable="true">
           </Context>

      4. Reiniciar el servidor Tomcat para que los cambios tengan efecto.

      Una vez hecho todo esto, podemos comprobar si la instalación se ha realizado correctamente, para lo cual en un navegador Web introducimos la dirección http://localhost:8080/axis y deberíamos ver la página de inicio de Axis. Además, Axis incluye una herramienta para validar la instalación llamada "Happydays" a la que se puede acceder desde la página de inicio de Axis (o directamente desde la dirección http://localhost:8080/axis/happyaxis.jsp). Una vez que el testeo que realiza Happydays sea correcto podremos comenzar a utilizar la aplicación.

    • Despliegue de la aplicación DMReMon

      Este paso consiste en desplegar la aplicación DMReMon dentro de Axis. Básicamente, desplegar una aplicación en Axis consiste en copiar las clases de la aplicación en un determinado sitio al que pueda acceder el Tomcat (ya que es quien ejecutará el código de la aplicación) y registrar los servicios Web que proporciona la aplicación en Axis para que de esta forma estos servicios puedan ser accesibles por la Web.

      Para la realización de este paso se ha incluido una tarea (o target) de Ant en el fichero build.xml llamada "deployServices". Por tanto, para realizar el despliegue bastará con ejecutar la orden "ant deployServices" desde el directorio de instalación de la aplicación DMReMon en standalone.

      Una vez hecho esto, ya se podría acceder a los servicios proporcionados por la aplicación aunque todavía faltará un detalle importante para su correcto funcionamiento: modificar el classpath del Tomcat. Esto se debe a que algunas clases de la aplicación acceden a determinados recursos que deberán estar en el classpath (concretamente al fichero monitor.properties), por tanto tendremos que modificar el classpath del Tomcat para que se puedan encontrar dichos recursos. Para modificar el classpath tendremos que editar el fichero setClasspath.sh (en el caso de Linux) o setClasspath.bat (en el caso de Windows). Ambos ficheros se encuentran en la ruta $CATALINA_HOME/bin.

    • Instalación del cliente DMReMon

      Los pasos para instalar el cliente de la aplicación son los siguientes:

      1. Descomprimir el contenido del fichero DMReMonClient-1.0.tar.gz en un directorio.
      2. En este punto ya podemos ejecutar el cliente de la aplicación ejecutando los scripts correspondientes: DMReMonClient.sh para Linux o DMReMonClient.bat para Windows pasando como argumentos el host donde está el servidor y el puerto donde escucha dicho servidor. Para que todo funcione correctamente, tendremos que ejecutar dichos scripts desde el directorio de instalación.
      3. Si queremos ejecutar el cliente de la aplicación desde otro directorio tendremos que exportar la variable de entorno DMREMON_CLIENT_HOME con el valor del directorio de instalación del cliente.