HCL Commerce Version 9.1.12.0 or later

Configuration de la journalisation pour le Approval server

Vous pouvez configurer la journalisation dans le Approval Server Docker container en exécutant le script setRuntimeTraceSpecs.

Procédure

  1. Facultatif : Si vous journalisez des appels d'API REST externes, vous devez définir le niveau de journalisation du client d'API Feign local, en fonction du niveau de détail de trace requis.
    1. Ouvrez le fichier de configuration app-secure.properties pour l'éditer dans votre volume persistant pour le Approval Server Docker container.
      Pour plus d'informations sur ce fichier, voir app-secure.properties.
    2. Définissez la valeur du niveau de journalisation.
      feign.client.config.default.loggerLevel=LOGGER_LEVEL
      Où les niveaux disponibles sont les suivants :
      • NONE - Ne rien consigner.
      • BASIC - Consigner la méthode de requête, l'URL, le code de statut de la réponse et le temps d'exécution.
      • HEADERS - Consigner les informations de base ainsi que les en-têtes de requête et de réponse.
      • FULL - Consigner les en-têtes, le corps et les métadonnées des requêtes et des réponses.
      Par défaut, le niveau de journalisation sur le Approval Server Docker container est défini sur BASIC.

      Pour plus d'informations sur le client Feign, voir Journalisation Feign dans la documentation Spring Cloud OpenFeign.

    3. Enregistrez et fermez le fichier.
    4. Redémarrez le conteneur.
      Les modifications apportées au client d'API Feign ne sont appliquées qu'une fois le conteneur redémarré.
  2. Définissez la spécification de trace dans votre Approval Server Docker container à l'aide du script setRuntimeTraceSpecs.
    1. Accédez au répertoire /SETUP/bin/.
    2. Exécutez le script setRuntimeTraceSpecs avec le ou les composants que vous souhaitez tracer.
      ./setRuntimeTraceSpecs.sh TRACE_COMPONENT_WITH_LEVEL

      La table suivante comprend les chaînes de suivi disponibles spécifiquement pour le Approval 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
      Problèmes liés à l'approbation de la place de marché
      com.hcl.commerce.approval.Logging=trace:com.hcl.commerce.approval.marketplace=trace
      
      Problèmes liés à la notification
      com.hcl.commerce.approval.Logging=trace:com.hcl.commerce.approval.notification=trace
      
      Problèmes liés à la stratégie de sécurité et de contrôle d'accès (ACP)
      com.hcl.commerce.approval.Logging=trace:com.hcl.commerce.approval.security=trace:com.hcl.commerce.approval.interceptors.ApprovalAccessHelperInterceptor=trace:com.hcl.commerce.approval.marketplace.access=trace
      Problèmes liés aux activités de nettoyage
      com.hcl.commerce.approval.Logging=trace:com.hcl.commerce.approval.marketplace.scheduler.ApprovalDBCleanUpScheduler=trace
      Problèmes liés à l'API REST externe
      com.hcl.commerce.approval.Logging=trace:com.hcl.commerce.approval.external.clients=trace
      Remarque : Selon le niveau de trace défini, il se peut que vous ne puissiez pas obtenir tous les détails du journal produit. Avant de définir le niveau de trace pour le Approval server, examinez l'étape 1 pour définir la valeur du niveau de journalisation appropriée pour Feign afin de capturer le niveau de prolixité approprié.
      Les niveaux de journalisation disponibles sont les suivants :
      • trace
      • debug
      • info
      • warn
      • error
      • fatal
      Remarque :
      • Lorsqu'il est configuré en tant que trace, tous les messages s'affichent.
      • Lorsqu'il est configuré en tant que debug, tous les messages sont affichés, à l'exception de ceux étiquetés comme trace.
      • Lorsqu'il est configuré en tant que info, tous les messages de niveau info à fatal sont affichés.
      Par défaut, les messages du journal du client API côté serveur s'affichent au niveau :
      • HCL Commerce Version 9.1.14.0info
      • HCL Commerce Version 9.1.13.0trace
      .

Résultats

La journalisation est maintenant configurée. Vous pouvez désormais reproduire tous les problèmes et collecter les journaux associés à des fins d'identification et de résolution des incidents.