Configuration d'un adaptateur pour la surveillance d'une application

L'adaptateur de journal générique fournit une classe Outputter qui permet l'envoi des objets CBE générés par l'adaptateur à un agent de consignation. Vous pouvez utiliser l'analyseur de trace et de journaux pour l'association à l'agent de consignation ainsi que pour contrôler et pour analyser le journal de l'application en temps réel.

Conditions prérequises :

Pour configurer l'adaptateur en vue de la surveillance, procédez comme indiqué ci-après.

Mise à jour du composant Outputter

Remarque : Lorsqu'il est créé, le fichier de configuration d'adaptateur est configuré pour utiliser la classe CBELogOutputter par défaut. Si vous n'avez pas modifié ce paramètre, vous pouvez ignorer cette procédure.

Il est nécessaire de mettre à jour le composant Outputter du fichier de configuration d'adaptateur pour qu'il utilise la classe CBELogOutputter, qui écrit les objets CBE sur un agent de consignation. Vous pouvez soit mettre à jour le composant Outputter existant, soit ajouter un nouveau composant Outputter.

Pour ajouter un nouveau composant Outputter :

  1. Pour éditer le fichier de configuration d'adaptateur, sélectionnez-le dans le panneau Navigateur. Cliquez dessus à l'aide du bouton de la souris et sélectionnez Ouvrir avec > Editeur de configuration d'adaptateur. Le fichier s'affiche dans l'éditeur.
  2. Dans la fenêtre de l'éditeur de configuration d'adaptateur, développez le noeud Adaptateur > Configuration > Instance de contexte.
  3. A l'aide du bouton droit de la souris, cliquez sur l'instance de contexte et sélectionnez Ajouter > Outputter. Un nouveau module Outputter est créé dans l'instance de contexte.
  4. Dans la zone Type d'outputter, sélectionnez LoggingAgentOutputter.
  5. Cliquez sur la propriété agentName. Les détails correspondants apparaissent dans le panneau de droite.
  6. Mettez à jour la valeur de la propriété en indiquant le nom de l'agent de consignation souhaité. Il s'agit du nom que vous verrez affiché dans l'analyseur de trace et de journaux pour désigner l'agent de consignation à surveiller.
  7. Si vous souhaitez que le module Outputter patiente avant de consigner des informations dans la classe CBELogOutputter, ajoutez une propriété appelée waitUntilLoggingTime et indiquez une durée en millisecondes. Pour ajouter la propriété, cliquez à l'aide du bouton droit de la souris sur le module Outputter nouvellement créé et sélectionnez Ajouter > Propriété. Une nouvelle propriété est créée sous le nouveau noeud Outputter.
  8. Pour activer la classe CBELogOutputter, vous devez créer le composant Outputter associé dans l'implémentation du contexte de base des contextes. Ouvrez Contextes > Context Basic Implementation Context.
  9. A l'aide du bouton droit de la souris, cliquez sur Context Basic Implementation Context et sélectionnez Ajouter > Composant. Un nouveau composant s'ajoute au contexte.
  10. Configurez le nouveau composant à l'aide des valeurs suivantes :
    Nom : Nom du module Outputter dans le contexte
    Description : Description de la fonction du module Outputter
    Classe de l'exécutable : org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    Niveau de consignation :Niveau de consignation interne que le composant Outputter doit utiliser.
    Une valeur égale à 99 signifie que le composant Outputter ne consigne aucun message.
    Une valeur de 0 signifie que le composant Outputter consigne les messages quel que soit leur niveau de sévérité.
    La valeur conseillée est de 50 et signifie que seuls les messages d'erreur internes de niveau critique ou fatal du composant Outputter sont consignés.
    Rôle : Outputter
    ID unique : Doit pointer vers le module Outputter défini dans l'instance de contexte à l'étape 2. Cliquez sur le bouton Parcourir pour sélectionner l'ID correct.
  11. Sauvegardez les modifications apportées au fichier de configuration d'adaptateur.

Mise à jour de l'instance de contexte

Si vous souhaitez que le programme d'analyse syntaxique de journal surveille le fichier journal en continu, vous devez mettre à jour en ce sens les propriétés de l'instance de contexte du fichier de configuration d'adaptateur.

  1. Pour éditer le fichier de configuration d'adaptateur, sélectionnez-le dans le panneau Navigateur. Cliquez dessus à l'aide du bouton de la souris et sélectionnez Ouvrir avec > Editeur de configuration d'adaptateur. Le fichier s'affiche dans l'éditeur.
  2. Dans la fenêtre de l'éditeur, sélectionnez Adaptateur > Configuration > Instance de contexte. Les détails correspondants apparaissent dans le panneau de droite.
  3. Cochez la case Opération continue.
  4. Renseignez les zones Délai d'inactivité maximal et Intervalle d'interruption.
  5. Sauvegardez les modifications apportées au fichier de configuration d'adaptateur.

Lancement du processus Java pour l'exécution de l'adaptateur

L'adaptateur de journal créé peut être exécuté en externe à partir d'un fichier de commande dans un environnement Windows ou à partir d'un script shell dans des environnement différents de Windows. Vous trouverez ci-après des exemples de fichiers pouvant être utilisés pour lancer le processus Java qui exécute l'adaptateur de journal.
Remarque : Pour exécuter l'adaptateur de journal générique sur un système, vous devez auparavant installer Hyades sur ce système.

Fichier de commande Windows :

@rem USAGE:  runregex
@rem Change the following lines to point to the directory where you unzipped the runtime
@rem and the directory where your log adapter resides 
SET HYADES_HOME=d:\hyadesDC
SET YOUR_ADAPTER_DIRECTORY=MyAdapterDirectory
SET CONFIG_FILE=%HYADES_HOME%\%YOUR_ADAPTER_DIRECTORY%\myadapter.adapter
PUSHD %HYADES_HOME%\%YOUR_ADAPTER_DIRECTORY%
java -classpath "%HYADES_HOME%\lib\glaconfigs.jar;%HYADES_HOME%\lib\hexr.jar;%HYADES_HOME%\lib\hgla.jar;%HYADES_HOME%\lib\hglaconfig.jar;%HYADES_HOME%\lib\hlcore.jar;%HYADES_HOME%\lib\hlevents.jar;%HYADES_HOME%\lib\hparse.jar;;%HYADES_HOME%\lib\logparsers.jar;%HYADES_HOME%\lib\xalan.jar;" org.eclipse.hyades.logging.adapter.Adapter -ac "%CONFIG_FILE%" -cc "%CONFIG_FILE%"
POPD
Fichier de commande pour des environnements autres que Windows :
#!/bin/sh
# USAGE:  runregex_example.sh
# Change the following line to point to the directory where you unzipped the runtime
HYADES_HOME=/home/hyadesDC
export HYADES_HOME
YOUR_DIRECTORY=/yourdirectory
export YOUR_DIRECTORY

CONFIG_FILE=$HYADES_HOME/$YOUR_DIRECTORY/myadapter.adapter
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd $HYADES_HOME/$YOUR_DIRECTORY

java -classpath "$HYADES_HOME\lib\glaconfigs.jar;$HYADES_HOME\lib\hexr.jar;$HYADES_HOME\lib\hgla.jar;$HYADES_HOME\lib\hglaconfig.jar;$HYADES_HOME\lib\hlcore.jar;$HYADES_HOME\lib\hlevents.jar;$HYADES_HOME\lib\hparse.jar;;$HYADES_HOME\lib\logparsers.jar;$HYADES_HOME\lib\xalan.jar;" org.eclipse.hyades.logging.adapter.Adapter -ac "$CONFIG_FILE" -cc "$CONFIG_FILE"
cd $CUR_DIR
Configurez le fichier de manière appropriée pour lancer le processus Java qui exécutera l'adaptateur.

Surveillance du journal de l'application

Vous pouvez maintenant surveiller le journal de l'application.

  1. Assurez-vous que la consignation est activée dans les préférences.
    1. Dans la barre d'outils principale, sélectionnez Fenêtre > Préférences. L'assistant Préférences apparaît.
    2. Sélectionnez Profilage et consignation dans le panneau de gauche. Les préférences de profilage et de consignation sont chargées dans le panneau de droite.
    3. Sélectionnez Activer la consignation sous Profilage et consignation.

      Consignation activée dans les préférences de profilage et de consignation

    4. Cliquez sur OK pour appliquer les modifications.
  2. Dans la perspective Profilage et consignation, cliquez sur l'icône Profilage Icône Profilage dans la barre d'outils et sélectionnez Profiler. L'assistant Profiler apparaît.
  3. Sélectionnez Connexion - Processus Java et cliquez sur le bouton Nouveau situé au bas de la liste. Une nouvelle configuration de processus Java est créée.
  4. Cliquez sur l'onglet Hôtes et sélectionnez l'hôte sur lequel réside le journal de l'application.
    Remarque : Dans le cadre de la surveillance d'un journal de l'application, le moteur de collecte de données Hyades doit être exécuté sur le même système que l'application.
  5. Cliquez sur l'onglet Agents et utilisez les touches fléchées pour sélectionner l'agent de consignation que vous avez configuré.

    Dans l'assistant des préférences de profilage, l'agent de consignation créé par l'utilisateur figure dans le panneau de gauche

  6. Cliquez sur Appliquer.
  7. Cliquez sur Exécuter pour effectuer l'association à l'agent de consignation.
  8. Dans la perspective Profilage et consignation de la vue Moniteur de profilage, sélectionnez l'agent de consignation.
  9. A l'aide du bouton droit de la souris, cliquez sur l'agent et sélectionnez Lancer la surveillance.
  10. A l'aide du bouton droit de la souris, cliquez sur l'agent et sélectionnez Ouvrir avec > Vue Journal. Les événements du journal figurant dans le journal de l'application sont chargés dans la vue Journal.

 

Concepts connexes
Présentation de l'adaptateur de journal générique Hyades
Spécification du format Common Base Event

Tâches connexes
Création d'un programme d'analyse syntaxique de journal

Références connexes
Structure du fichier de configuration d'adaptateur
Editeur de configuration d'adaptateur
Syntaxe d'une expression régulière