Cómo empezar con el servicio de Analytics

Bienvenido a Cómo empezar con el servicio de Analytics. Esta página es el punto de partida para obtener información sobre el servicio de Analytics. Se tratan los temas siguientes:

Visión general

La aplicación de servicio de Analytics se creó para complementar el uso de dojox.analytics y plugins relacionados desde Dojo Toolkit for JavaScript. Analytics proporciona una forma de realizar el seguimiento de sucesos (Dojo, pulsaciones del ratón, etc.) y generar registro desde el código del lado del cliente. La información de análisis a menudo se gestiona en el cliente y se puede enviar a varios servidores distintos de análisis. Esto puede ser complicado y a menudo requiere la comunicación con dominios externos al servidor que ha proporcionado la aplicación. El servicio de Analytics proporciona una forma de manejar la multiplexación de análisis y registro en el lado del servidor. El código existente dojox.analytics en el cliente envía los sucesos al mismo servidor que ha proporcionado la aplicación, lo que elimina los posibles problemas entre dominios.

En el servidor, la aplicación del servicio de Analytics incluye un recurso JAX-RS del lado del servidor que acepta las solicitudes enviadas desde el código dojox.analytics de los clientes. Los parámetros de inicialización de servlet se pueden establecer en la aplicación del servicio de Analytics para configurar cómo maneja los sucesos de análisis. De forma predeterminada, todos los sucesos se envían a un archivo de registro único, analytics_default.log.

Requisitos previos

Requisitos previos del producto Versión
Java Technology Edition 5.0 y posteriores
Servidor de aplicaciones Java Platform, Enterprise Edition 5 (Java EE) y posteriores

WebSphere Application Server Versión 6.1.0.x y posteriores

WebSphere Application Server Community Edition Versión 2.X

Navegador web Cualquier navegador web actual, como: Internet Explorer 7 y posteriores, Mozilla Firefox 3.x y posteriores, Google Chrome, Safari, Opera

Utilización del servicio de Analytics

El servicio de Analytics sólo es útil si el JavaScript del lado del cliente utiliza dojox.analytics. Para acceder a las herramientas desde dojox.analytics, el JavaScript lado del cliente sólo debe incluir la sentencia requieres adecuada. Con la incorporación de esta dependencia, hay disponibles varias opciones para generar sucesos. Consulte los ejemplos siguientes:

Habilitar la capacidad de generar sucesos.

dojo.require("dojox.analytics.plugins.dojo");

Generar un suceso dojox.analytics con texto arbitrario.

console.rlog("Aquí cualquier serie entre comillas.");

Realizar un registro con una indicación de fecha y hora de alta precisión.

dojox.analytics.addData("indicación de fecha y hora", [new Date().getTime(), "on-load executed"]);

Además de seleccionar de qué sucesos dojox.analytics realizará un seguimiento, se requiere configuración para identificar el URL relativo o absoluto del servicio de Analytics. También puede utilizar los parámetros siguientes:

Parámetro djConfig Significado y posibles valores ¿Necesario?
analyticsUrl: URL del servicio de Analytics, completo o relativo al recurso actual
sendMethod 'script' o 'xhrPost' (valor predeterminado) sendMethod: se requiere 'script' si el servicio de Analytics se encuentra en un dominio distinto de la página que realiza la referencia.
sendInterval Número de milisegundos durante los que se acumularán sucesos antes de enviarlos al servicio de Analytics No, el valor predeterminado es de 5000 milisegundos

La configuración predeterminada envía todos los sucesos a un único archivo de registro, analytics_default.log, que se encuentra en el directorio definido por la propiedad del sistema java.io.tmpdir del servidor de la JVM del servidor. Este nombre y vía de acceso de archivo de registro de salida se puede personalizar mediante los valores del archivo web.xml. Para ello, deberá especificar la vía de acceso completa del archivo donde desea que se registren los sucesos, en el param-value del param-name com.ibm.ws.mobile.appsvcs.analytics.logger.LocalFileLogger. También deberá especificar un valor de '1.0' para identificar la versión de sintaxis que utilizará el servicio. Esto es necesario, y es simplemente para permitir el mantenimiento de versiones en el futuro.

El siguiente fragmento del archivo web.xml muestra su uso:

...
<init-param>
    <param-name>com.ibm.ws.mobile.appsvcs.analytics.logger.LocalFileLogger</param-name>
    <param-value>1.0,/tmp/events.log</param-value>
</init-param>
...

También puede personalizar adicionalmente el formato del registro especificando qué otra información se registra como parte de cada entrada de registro. Esto puede hacerse mediante los valores de las propiedades del archivo web.xml. Para ello, simplemente especifique una o más de las palabras clave predefinidas en el param-value del param-name com.ibm.ws.mobile.appsvcs.analytics.logger.LocalFileLogger.LogFormat.

El siguiente fragmento del archivo web.xml muestra su uso:

...
<init-param>
    <param-name>com.ibm.ws.mobile.appsvcs.analytics.logger.LocalFileLogger.LogFormat</param-name>
    <param-value>CLIENT_IP,CLIENT_SESSION,HTTP_REFERER</param-value>
</init-param>
...

Puede elegir entre cualquiera de las siguientes palabras clave predefinidas:

Entrada de formato de registro Qué se registra
CLIENT_SESSION registra HttpServletRequest#getRequestedSessionId(), el ID de sesión de la solicitud especificado por el cliente
CLIENT_SESSION_FORCED registra HttpServletRequest#getSession(true).getId(), forzando la creación de una sesión HTTP si no existe y registrando su ID de sesión
CLIENT_IP registra HttpServletRequest#getRemoteAddr(), la dirección IP (Internet Protocol) del cliente
HTTP_REFERER registra HttpServletRequest#getHeader(), la cabecera de la solicitud

El paso siguiente en la utilización del servicio de Analytics es iniciar la aplicación y configurarla. Para iniciarla, sólo requiere instalar y desplegar el archivo .ear.

Interfaz REST del servicio de Analytics

Cuando un cliente utiliza dojox.analytics, los sucesos que genera producen solicitudes HTTP que se envían a un servidor de análisis. El servicio de Analytics procesa estas solicitudes exponiendo una interfaz REST (Representation State Transfer). Consulte la tabla siguiente, que describe las operaciones disponibles.

El servicio de Analytics manejará las solicitudes dirigidas a http://<servidor>:<puerto>/<raíz-contexto>/<patrón-url>/analytics/logger. La raíz de contexto se define mediante el archivo application.xml si el archivo de archivador web (.war) está empaquetado en un archivo de archivador de empresa (.ear). Si el .war se instala por sí mismo, la raíz de contexto la define durante la instalación el usuario. La correlación de uri se define en WEB-INF/web.xml en el archivo .war.

En el appsvcs-analytics.ear proporcionado, el archivo application.xml especifica una raíz de contexto de "/appsvcs-analytics" y el archivo web.xml especifica un patrón de "/rest/*".

Descripción de la operación Método URI Parámetros
Notifica una lista de sucesos GET /appsvcs-analytics/rest/analytics/logger Existen dos parámetros de consulta necesarios (id y data) y uno que es opcional (callback).
Notifica una lista de sucesos POST /appsvcs-analytics/rest/analytics/logger La solicitud POST utiliza los mismos parámetros, pero estos no forman parte de la consulta de URI. En lugar de ello, se encuentran en el cuerpo de la solicitud HTTP. A continuación se proporcionan ejemplos.

En la tabla siguiente se proporciona una descripción de cada uno de los parámetros.

Parámetro de consulta Descripción
id Identificador de suceso exclusivo
data Matriz de sucesos con formato JSON
callback Nombre del método JavaScript que se debe incluir en la respuesta. Consulte la siguiente información sobre el formato de la respuesta.

Las respuestas a las solicitudes POST y GET no son diferentes. Sin embargo, el formato de la respuesta es ligeramente distinto si se incluye en la respuesta el parámetro callback opcional. Los ejemplos siguientes describen el formato.

Descripción Solicitud de ejemplo Respuesta de ejemplo
GET con callback GET /appsvcs-analytics/rest/analytics/logger?id=1&callback=method &data=[{"plugin":"dojo","data":{"locale":"en-us"}}] method({"eventsReceived":1,"id":"1"})
GET sin callback GET /appsvcs-analytics/rest/analytics/logger?id=1 &data=[{"plugin":"dojo","data":{"locale":"en-us"}}] {"eventsReceived":1,"id":"1"}
POST con callback POST /appsvcs-analytics/rest/analytics/logger, HTTP body: id=1&callback=method &data=[{"plugin":"dojo","data":{"locale":"en-us"}}] method({"eventsReceived":1,"id":"1"})
POST sin callback POST /appsvcs-analytics/rest/analytics/logger, HTTP body: id=1 &data=[{"plugin":"dojo","data":{"locale":"en-us"}}] {"eventsReceived":1,"id":"1"}

Cada solicitud enviada al servicio REST genera una respuesta HTTP, que incluye un código de estado para indicar el tipo de resultado satisfactorio o anomalía. Estos resultados se correlacionan correctamente con los códigos de estado HTTP habituales.

Código de estado Descripción
200 La operación solicitada ha sido satisfactoria.
400 La solicitud incluía valores incorrectos en los parámetros o en el cuerpo de la solicitud.
405 Hay un URI no soportado en la solicitud REST.
406 El cliente no da soporte al formato JSON necesario, según la cabecera de la solicitud.
415 La solicitud de cliente incluye un tipo de contenido no soportado.
500 Se ha producido un error inesperado en el servidor.

Instalación del servicio de Analytics

Consulte las siguientes instruccciones de instalación específicas de la versión:

Instrucciones de instalación de WebSphere Application Server

En esta sección se describe el procedimiento para instalar el servicio de Analytics en la versión 6.1.0.X y posteriores de IBM WebSphere Application Server. Se presupone que está familiarizado con la instalación y la administración de la aplicación para el servidor de aplicaciones.

Antes de empezar

Localice el archivo EAR (archivador empresarial) del servicio de Analytics que se proporciona con la instalación del producto. Puede encontrar el archivo EAR en el árbol de instalación donde ha instalado IBM WebSphere Application Server Feature Pack for Web 2.0 and Mobile. Por ejemplo, si ha instalado el paquete de características en la siguiente ubicación:

Linux y UNIX: /opt/WebSphere/AppServer
Punto de montaje en z/OS: <raíz_instalación>
Windows: c:\WebSphere\AppServer

A continuación, puede encontrar el archivo EAR en:

Linux y UNIX: /opt/WebSphere/AppServer/web2mobilefep_1.1/installableApps/application_services/analytics/appsvcs-analytics.ear
z/OS: <raíz_instalación>/web2mobilefep_1.1/installableApps/application_services/analytics/appsvcs-analytics.ear
Windows: c:\WebSphere\AppServer\web2mobilefep_1.1\installableApps\application_services\analytics\appsvcs-analytics.ear

Instalación del servicio de Analytics mediante la consola de administración

  1. Inicie la sesión en la consola de administración para el servidor de aplicaciones.
  2. Vaya a Aplicaciones > Aplicación nueva. (Nota: en WebSphere Application Server Versión 6.1, seleccione Instalar aplicación nueva)
  3. Seleccione Nueva aplicación empresarial. (Nota: en WebSphere Application Server Versión 6.1, sáltese este paso)
  4. Examine el sistema de archivos y seleccione el archivo appsvcs-graphics.ear que ha localizado anteriormente. Pulse Siguiente.
  5. Pulse Siguiente para preparar la instalación de la aplicación. (Nota: en WebSphere Application Server Versión 6.1, sáltese este paso)
  6. Pulse Siguiente para aceptar las opciones de instalación predeterminadas.
  7. Pulse Siguiente para aceptar las opciones predeterminadas para correlacionar módulos con servidores.
  8. Pulse Siguiente para aceptar las opciones predeterminadas para metadatos para módulos. (Nota: en WebSphere Application Server Versiones 6.1 y 7, sáltese este paso)
  9. Pulse Siguiente para aceptar las opciones predeterminadas para correlacionar hosts virtuales para módulos web.
  10. Revise el resumen de las opciones de instalación.
  11. Pulse Finalizar.
  12. Pulse Guardar en la configuración maestra.
  13. Vaya a Aplicaciones > Tipos de aplicación > Aplicaciones empresariales WebSphere. (Nota: en WebSphere Application Server Versión 6.1, vaya a Aplicaciones > Aplicaciones empresariales)
  14. Seleccione IBM WebSphere Application Server - Servicio de Analytics y pulse Iniciar.

Acceda al cliente de demostración de la aplicación instalado

Apunte el navegador web a la instalación del servidor de aplicaciones: http://<nombre de host del servidor de aplicaciones>:<puerto>/appsvcs-analytics/

El nombre de host y el número de puerto del servidor de aplicaciones son específicos de su instalación de servidor de aplicaciones. Un puerto de contenedor web de instalación predeterminado de servidor de aplicaciones es 9080. Si ejecuta el navegador web en la misma estación de trabajo que la instalación del servidor de aplicaciones y ha aceptado todos los valores predeterminados, utilice el URL siguiente: http://localhost:9080/appsvcs-analytics/.

Instrucciones de instalación de WebSphere Application Server Community Edition Versión 2.X

En esta sección se describe el procedimiento para instalar el servicio de Analytics en la versión 2.x de IBM WebSphere Application Server Community Edition. Se presupone que está familiarizado con la instalación y la administración de la aplicación para el servidor de aplicaciones.

Antes de empezar

Localice el archivo EAR (archivador empresarial) del servicio de Analytics que se proporciona con la instalación del producto. Puede encontrar el archivo EAR en el árbol de instalación donde ha instalado IBM WebSphere Application Server Feature Pack for Web 2.0 and Mobile. Por ejemplo, si ha instalado el paquete de características en la siguiente ubicación:

Linux y UNIX: /opt/WebSphere/AppServerCommunityEdition
Windows: c:\WebSphere\AppServerCommunityEdition

A continuación, puede encontrar los archivos EAR y de biblioteca en:

Linux y UNIX: /opt/WebSphere/AppServerCommunityEdition/web2mobilefep_1.1/AppServices/installableApps/analytics/appsvcs-analytics.ear
Windows: c:\WebSphere\AppServerCommunityEdition\web2mobilefep_1.1\AppServices\installableApps\analytics\appsvcs-analytics.ear

Instalación mediante la consola de administración

Inicie la sesión en la consola de administración para el servidor de aplicaciones.

  1. Pulse Aplicaciones > Aplicación de despliegue en el menú de la izquierda. (Nota: en WebSphere Application Server Community Edition Versión 2.0, pulse Aplicaciones > Desplegar nueva)
  2. En el campo Archivo, examine el sistema de archivos y seleccione el archivo appsvcs-analytics.ear que ha localizado anteriormente. Deje vacío el campo Plan y las opciones predeterminadas seleccionadas. A continuación, pulse Instalar.

La aplicación se inicia automáticamente y se completa la instalación.

Acceda al cliente de demostración de la aplicación instalado

Apunte el navegador web a la instalación del servidor de aplicaciones: http://<host del servidor de aplicaciones>:<puerto>/appsvcs-analytics/.

El nombre de host y el puerto del servidor de aplicaciones son específicos de su instalación de servidor de aplicaciones. El puerto de contenedor web de instalación predeterminado del servidor WebSphere Application Server Community Edition es 8080. Si está ejecutando el navegador web en la misma estación de trabajo que la instalación del servidor de aplicaciones y ha aceptado todos los valores predeterminados, utilice el URL siguiente:

http://localhost:8080/appsvcs-analytics/