Bienvenue dans le service d'analyses. Cette page représente le point de départ de découverte du service d'analyses. Les rubriques suivantes sont traitées :
L'application de service d'analyses a été créé pour compléter l'utilisation des plug-in dojox.analytics et associés à partir de Dojo Toolkit for JavaScript. Les analyses représentent un moyen de suivre les événements (Dojo, clics de souris, etc.) et de générer une consignation à partir du code côté client. Les informations d'analyses sont souvent gérées sur le client et envoyées aux potentiels différents serveurs d'analyses. Ceci peut s'avérer lourd et requiert souvent une communication avec des domaines situés à l'extérieur du serveur ayant fourni l'application. Le service d'analyses fournit un moyen de gérer le multiplexage des analyses et la consignation côté serveur. Le code dojox.analytics existant sur le client envoie les événements au même serveur ayant fourni l'application, ce qui élimine les problèmes liés aux domaines.
Sur le serveur, l'application de service d'analyses inclut une ressource JAX-RS côté serveur qui accepte les requêtes envoyés du code dojox.analytics des clients. Les paramètres d'initialisation du servlet peuvent être définis dans l'application de service d'analyses pour configurer la manière dont les événements d'analyses sont gérés. Par défaut, tous les événements sont envoyés dans un fichier journal unique, analytics_default.log.
Prérequis produit | Version |
---|---|
Java Technology Edition | 5.0 et version ultérieure |
Serveur d'application Java Platform, Enterprise Edition 5 (Java EE) et version ultérieure | WebSphere Application Server Version 6.1.0.x et ultérieure WebSphere Application Server Community Edition Version 2.X |
Navigateur Web | Tout navigateur Web moderne, tel que Internet Explorer 7 et version ultérieure, Mozilla Firefox 3.x et version ultérieure, Google Chrome, Safari, Opera |
Le service d'analyses est uniquement utile si le JavaScript côté client analyse dojox.analytics. Pour accéder aux outils de dojox.analytics, le JavaScript côté client doit inclure uniquement la bonne instruction requires. Avec cette dépendance extraite, plusieurs options sont disponibles pour générer des événements. Voir les exemples suivants :
Permettre la génération d'événements.
dojo.require("dojox.analytics.plugins.dojo");
Générer un événement dojox.analytics avec du texte arbitraire.
console.rlog("toute chaîne entre guillemets ici.");
Consignez quelque chose avec un horodatage de haute précision.
dojox.analytics.addData("horodatage", [new Date().getTime(), "on-load executed"]);
Au-delà de la sélection des événements à suivre par dojox.analytics, la configuration pour identifier l'URL absolue ou relative du service des analyses est requise. Vous pouvez également utiliser les paramètres suivants :
Paramètre djConfig signification et valeurs possibles Requis(e) ? analyticsUrlc: URL du service d'analyses, complètement qualifiée ou relative de la ressource actuelle Oui sendMethod 'script' ou 'xhrPost' (par défaut) sendMethod : 'script' est requis si le service d'analyses est situé sur un domaine différent de la page référente. sendInterval Nombre de millisecondes pour accumuler les événement avant l'envoi au service d'analyses Non, valeur par défaut : 5000 millisecondes
La configuration par défaut envoie tous les événements dan un seul fichier journal, analytics_default.log, situé dans le répertoire défini par la propriété système java.io.tmpdir du serveur à partir du serveur JVM. Les chemin et nom de ce fichier journal peuvent être personnalisés via la configuration des propriétés dans le fichier web.xml. Pour ce faire, vous devez spécifier le chemin complet du fichier dans lequel vous souhaitez que les événements soient consignés, dans la valeur param-value du nom param-name com.ibm.ws.mobile.appsvcs.analytics.logger.LocalFileLogger. Vous devez également spécifier une valeur de '1.0' pour identifier la version de syntaxe à utiliser par le service. Ceci est obligatoire, pour autoriser la gestion des versions à l'avenir.
La partie suivante du fichier web.xml démontre son utilisation :
... <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> ...
Vous pouvez également personnaliser le format du journal en spécifiant les autres informations enregistrées en entrées journal. Cette opération s'effectue via la configuration des propriétés dans le fichier web.xml. Pour ce faire, spécifiez simplement un ou plusieurs des mots clés dans la valeur param-value du nom param-name com.ibm.ws.mobile.appsvcs.analytics.logger.LocalFileLogger.LogFormat.
La partie suivante du fichier web.xml démontre son utilisation :
... <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> ...
Vous pouvez faire votre choix parmi les mots clé prédéfinis suivants :
entrée de format journal ce qui est consigné CLIENT_SESSION consigne HttpServletRequest#getRequestedSessionId(), l'ID de session de la requête indiqué par le client CLIENT_SESSION_FORCED consigne HttpServletRequest#getSession(true).getId(), forçant la création d'un session HTTP le cas échéant et consignant son ID de session CLIENT_IP consigne HttpServletRequest#getRemoteAddr(), l'adresse IP du client HTTP_REFERER consigne HttpServletRequest#getHeader(), l'en-tête de la requête
La prochaine étape d'utilisation du service d'analyses est de démarrer l'application et de la configurer. Son démarrage requiert uniquement l'installation et le déploiement du fichier .ear.
Lorsqu'un client utilise dojox.analytics, les événements générés entraînent des requêtes HTTP envoyées à un serveur d'analyse. Le service d'analyses traite ces requêtes en exposant une interface REST (Representation State Transfer). Voir la table suivante, qui décrit les opérations disponibles.
Le service d'analyes gère les requêtes ciblées à l'emplacement http://<server>:<port>/<context-root>/<url-pattern>/analytics/logger. La racine de contexte est définie par le fichier application.xml si votre fichier archive Web (.war) est intégré à un fichier .ear. Si le fichier .war est installé seul, la racine de contexte est définie au moment de l'installation par l'utilisateur. Le mappage d'uri est défini dans le WEB-INF/web.xml dans le fichier .war.
Dans l'appsvcs-analytics.ear fourni, le fichier application.xml indique une racine contexte de "/appsvcs-analytics" et le fichier web.xml indique un modèle d'URL de "/rest/*".
Description d'opération Méthode URI Paramètres Rapporte une liste d'événements GET /appsvcs-analytics/rest/analytics/logger Il existe deux paramètres de requêtes requis (id et données) et un qui est facultatif (rappel). Rapporte une liste d'événements POST /appsvcs-analytics/rest/analytics/logger La requête POST utilise les mêmes paramètres, mais il ne font pas partie de la requête URI. Ils sont au contraire dans le corps de la requête HTTP. Voici quelques exemples.
La table suivante fournit une description pour chacun des paramètres.
Paramètre de requête Description id Identifiant d'événement unique données grappe formatée JSON d'événements rappel Le nom de la méthode JavaScript devant être incluse dans la réponse. Voir les informations suivantes sur le format de la réponse.
Les réponses aux requêtes POST et GET ne sont pas différentes. Toutefois, le format de la réponse est légèrement différent si le paramètre de rappel facultatif est inclus à la requête. Les exemples suivants résument le format.
Description Exemple de requête Exemple de réponse GET avec rappel GET /appsvcs-analytics/rest/analytics/logger?id=1&callback=method &data=[{"plugin":"dojo","data":{"locale":"en-us"}}] method({"eventsReceived":1,"id":"1"}) GET sans rappel GET /appsvcs-analytics/rest/analytics/logger?id=1 &data=[{"plugin":"dojo","data":{"locale":"en-us"}}] {"eventsReceived":1,"id":"1"} POST avec rappel 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 sans rappel POST /appsvcs-analytics/rest/analytics/logger, HTTP body: id=1 &data=[{"plugin":"dojo","data":{"locale":"en-us"}}] {"eventsReceived":1,"id":"1"}
Chaque requête envoyée au service REST entraîne une réponse HTTP, qui inclut un code de statut pour indiquer le type de réussite ou d'échec. Ces résultats correspondent bien aux codes de statut HTTP courants.
Code de statut Description 200 L'opération demandée a réussi. 400 La requête comportait des valeurs incorrectes dans les paramètres ou le corps de la requête. 405 Un URI non pris en charge se trouve dans la requête REST. 406 Le client ne prend pas en charge le format JSON requis, selon les en-têtes de requête. 415 La requête client inclut un type de contenu non pris en charge. 500 Une erreur inattendue s'est produite dans le serveur.
Reportez-vous aux instructions d'installation spécifiques à chaque version :
Cette section décrit la procédure d'installation du service d'analyses sur la Version 6.1.0.X et ultérieure d'IBM WebSphere Application Server. Vous devez avoir des bonnes connaissances sur l'administration et l'installation de l'application pour le serveur d'application.
Localisez le fichier d'archive (EAR) du service d'analyses qui est fourni avec l'installation de votre produit. Vous le trouverez dans votre arborescence d'installation où vous avez installé IBM WebSphere Application Server Feature Pack for Web 2.0 and Mobile. Par exemple, si vous avez installé le module de fonctions à l'emplacement suivant :
Linux et UNIX : /opt/WebSphere/AppServer point de montage z/OS : <install_root> Windows : c:\WebSphere\AppServer
Vous trouverez alors le fichier EAR à l'emplacement suivant :
Linux et UNIX : /opt/WebSphere/AppServer/web2mobilefep_1.1/installableApps/application_services/analytics/appsvcs-analytics.ear z/OS : <install_root>/web2mobilefep_1.1/installableApps/application_services/analytics/appsvcs-analytics.ear Windows : c:\WebSphere\AppServer\web2mobilefep_1.1\installableApps\application_services\analytics\appsvcs-analytics.ear
- Connectez-vous à la console administrative pour le serveur d'application.
- Naviguez jusqu'à Applications > Nouvelle application. (Note : dans WebSphere Application Server Version 6.1, sélectionnez Installation d'une nouvelle application)
- Sélectionnez New Enterprise Application. (Note : dans WebSphere Application Server Version 6.1, ignorez cette étape)
- Parcourez votre système de fichiers et sélectionnez le fichier appsvcs-graphics.ear localisé précédemment. Cliquez sur Suivant.
- Cliquez sur Suivant pour préparer l'installation d'application. (Note : dans WebSphere Application Server Version 6.1, ignorez cette étape)
- Cliquez sur Suivant pour accepter les options d'installation par défaut.
- Cliquez sur Suivant pour accepter les options par défaut pour le mappage des modules vers les serveurs.
- Cliquez sur Suivant pour accepter les options par défaut pour les métadonnées des modules. (Note : dans WebSphere Application Server Versions 6.1 et 7, ignorez cette étape)
- Cliquez sur Suivant pour accepter les options par défaut pour le mappage des hôtes virtuels pour les modules Web.
- Consultez le récapitulatif des options d'installation.
- Cliquez sur Terminer.
- Cliquez sur Sauvegarder dans la configuration principale.
- Naviguez jusqu'à Applications > Types d'application > WebSphere Enterprise Applications. (Note : dans WebSphere Application Server Version 6.1, naviguez jusqu'à Applications > Enterprise Applications)
- Sélectionnez IBM WebSphere Application Server - Analytics Service, et cliquez sur Démarrer.
Pointez votre navigateur Web vers votre installation de serveur d'application : http://<nom d'hôte de serveur d'application>:<port>/appsvcs-analytics/
Les numéro de port et nom d'hôte du serveur d'application sont spécifiques à votre installation de serveur d'application. Le port de conteneur Web d'installation par défaut du serveur d'application est 9080. Si vous exécutez votre navigateur Web sur le même poste de travail que votre installation de serveur d'application et avez opté pour toutes les valeurs par défaut, utilisez l'URL suivante : http://localhost:9080/appsvcs-analytics/.
Cette section décrit la procédure d'installation du service d'analyses dans la Version 2.X d'IBM WebSphere Application Server Community Edition. Vous devez avoir des bonnes connaissances sur l'administration et l'installation de l'application pour le serveur d'application.
Localisez le fichier d'archive (EAR) du service d'analyses qui est fourni avec l'installation de votre produit. Vous le trouverez dans votre arborescence d'installation où vous avez installé IBM WebSphere Application Server Feature Pack for Web 2.0 and Mobile. Par exemple, si vous avez installé le module de fonctions à l'emplacement suivant :
Linux et UNIX : /opt/WebSphere/AppServerCommunityEdition Windows : c:\WebSphere\AppServerCommunityEdition
Vous trouverez alors les fichiers de bibliothèque et EAR à l'emplacement suivant :
Linux et 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
Connectez-vous à la console administrative pour le serveur d'application.
- Cliquez sur Applications > Deployer dans le menu de gauche. (Note : dans WebSphere Application Server Community Edition Version 2.0, cliquez sur Applications > Déployer)
- Dans la zone Archive, parcourez votre système de fichiers et sélectionnez le fichier appsvcs-analytics.ear localisé précédemment. Laissez la zone Plan vide et les options par défaut sélectionnées. Cliquez alors sur Installer.
L'application démarre automatiquement ; l'installation est terminée.
Pointez votre navigateur Web vers votre installation de serveur d'application : http://<nom d'hôte de serveur d'application>:<port>/appsvcs-analytics/.
Les port et nom d'hôte du serveur d'application sont spécifiques à votre installation de serveur d'application. Le port de conteneur Web d'installation par défaut de serveur WebSphere Application Server Community Edition est 8080. Si vous exécutez votre navigateur Web sur le même poste de travail que votre installation de serveur d'application et avez opté pour toutes les valeurs par défaut, utilisez l'URL suivante :