Configuration de la journalisation pour le Search server

Vous pouvez configurer la connexion dans le Search server Docker container en utilisant les commandes Run Engine.

Remarque :

Lorsque vous collaborez avec IBM pour déboguer des incidents relatifs au traitement d'une requête, il est possible que, dans certains cas, des composants de traçage de bas niveau doivent être activés pour capturer des informations détaillées sur la façon dont la requête est traitée. Ces composants de traçage Application Server de bas niveau ne connaissent pas l'intention de la requête ni les données potentielles qu'elle contient. Par conséquent, une fois activés, il est possible que ces composants de traçage incluent des informations confidentielles, en texte en clair, dans le fichier de trace.

Il est conseillé de ne pas activer ces types de composants de traçage sur un système de production et d'essayer de simuler l'incident dans un environnement d'assurance qualité afin de capturer les informations appropriées. Cependant, si les composants de la fonction de trace doivent être activés sur un système de production, gérez les fichiers de trace avec précaution. Avant d'envoyer la trace, supprimez des données confidentielles qui peuvent être dans le fichier de trace avant de permettre à un tiers d'utiliser la trace pour diagnostic. Par ailleurs, une fois que la trace n'est plus nécessaire, supprimez les fichiers à l'aide d'un processus d'effacement des données d'un niveau de fiabilité supérieur. Lorsque le problème est trouvé et le composant de traçage n'est plus nécessaire, désactivez immédiatement les composants de traçage de bas niveau.

Procédure

  • Activez le traçage dans votre conteneur cible à l'aide des commandes Run Engine. Il existe différentes méthodes de mise en oeuvre.
    Méthode Procédure
    Activation de la trace dans un conteneur en cours d'exécution dans votre environnement Docker local. Utilisez cette méthode dans votre environnement local d'assurance qualité ou de développement.
    1. Entrez votre conteneur cible. 
      docker exec -it container_name bash
    2. Définissez votre spécification de trace. Par exemple, la commande suivante ajoute une trace sur ServiceLogger. Pour obtenir une liste de spécifications, voir Chaînes de suivi.
      run set-trace-specification com.ibm.commerce.foundation.logging.ServiceLogger=FINEST
    3. Par défaut, le suivi sort en tant que STDOUT. Si vous souhaitez sortir le suivi vers un fichier journal, puis mettre à jour /opt/WebSphere/Liberty/usr/servers/default/configDropins/overrides/logging.xml et remplacer traceFileName=stdout par traceFileName=trace.log. Sauvegardez le fichier et redémarrez le conteneur.
    4. Reproduisez le problème.
    5. Si vous n'avez pas configuré votre conteneur Docker pour commencer par un montage de volume afin de préserver les journaux dans l'ordinateur hôte Docker, alors exécutez les commandes suivantes pour rendre le suivi disponible sur l'hôte Docker.
      docker cp container_name:/profile/logs/trace.log /tmp/container_name_trace.log
    Création d'une nouvelle image Docker pour inclure la spécification de trace par défaut lors du démarrage. Utilisez cette méthode pour créer des images Docker personnalisées afin de définir la spécification de trace par défaut. Ensuite, vous pouvez distribuer l'image Docker personnalisée.
    1. Créez un fichier Dockerfile pour l'image Docker cible.
    2. Dans le fichier Dockerfile, définissez la commande Run Engine pour définir votre spécification de trace. Par exemple, 
      run set-trace-specification com.ibm.commerce.foundation.logging.ServiceLogger=FINEST
    3. Par défaut, le suivi sort en tant que STDOUT. Si vous souhaitez sortir le suivi vers un fichier journal, puis mettre à jour /opt/WebSphere/Liberty/usr/servers/default/configDropins/overrides/logging.xml et remplacer traceFileName=stdout par traceFileName=trace.log. Sauvegardez le fichier et redémarrez le conteneur.
    4. Créez une image Docker avec le fichier Dockerfile.
    Fourniture de la spécification de trace dans un système avancé avec des outils d'orchestration et un centre de configuration à distance. Cette méthode inclut également la spécification de trace par défaut lors du démarrage. Les images Docker peuvent accepter une valeur de paramètre TRACE_SPEC lors du démarrage du conteneur.
    1. Vérifiez que vous avez configuré votre outil d'orchestration pour extraire les paramètres de configuration de votre centre de configuration.
    2. Dans votre centre de configuration (tel que Vault), définissez la spécification de suivi dans le paramètre TRACE_SPEC.
    3. A présent, lorsque de nouveaux conteneurs sont déployés, les conteneurs seront configurés avec vos spécifications de trace.
  • Chaînes de trace

    La table suivante comprend les chaînes de suivi disponibles spécifiquement pour le Search server Docker container. Dans certains cas, vous devrez peut-être activer les chaînes de suivi dans plusieurs serveurs pour identifier et résoudre entièrement les incidents d'un composant. Pour plus d'informations, voir les sections MustGather dans Composants de trace.

    Composant Chaîne de trace
    Rechercher l'index de génération 
    *=info:com.ibm.commerce.foundation.*=all:
com.ibm.commerce.search.*=all:
org.apache.solr.*=all:
com.ibm.commerce.solr.*=all
    Rechercher l'invalidation du cache 
    *=info:com.ibm.commerce.foundation.*=all: 
com.ibm.commerce.search.*=all: 
org.apache.solr.*=all: 
com.ibm.commerce.solr.*=all
    Rechercher la création principale 
    *=info:com.ibm.commerce.foundation.*=all: 
com.ibm.commerce.search.*=all: 
org.apache.solr.*=all: 
com.ibm.commerce.solr.*=all
    Facettes de recherche 
    *=info:com.ibm.commerce.foundation.*=all:
com.ibm.commerce.search.*=all: 
com.ibm.commerce.rest.*=all
    Rechercher le contrôle d'intégrité 
    *=info:com.ibm.commerce.foundation.*=all: 
com.ibm.commerce.search.*=all: 
org.apache.solr.*=all:
com.ibm.commerce.solr.*=all
    Pertinence de la recherche 
    *=info:com.ibm.commerce.foundation.*=all:
com.ibm.commerce.rest.*=all
    Rechercher la réplication 
    *=info:com.ibm.commerce.foundation.*=all: 
com.ibm.commerce.search.*=all: 
org.apache.solr.*=all: 
com.ibm.commerce.solr.*=all
    Règles de recherche 
    com.ibm.commerce.rest.*=all:
com.ibm.commerce.foundation.*=all
    Rechercher les catégories de vente basées sur les règles 
    com.ibm.commerce.rest.*=all:com.ibm.commerce.foundation.*=all
    Exécution de la recherche 
    *=info:com.ibm.commerce.foundation.*=all: 
com.ibm.commerce.search.*=all: 
com.ibm.commerce.rest.*=all
    Rechercher des associations de termes et des pages d'accueil 
    *=info:com.ibm.commerce.foundation.*=all: 
com.ibm.commerce.search.*=all: 
com.ibm.commerce.rest.*=all