Utilisation de l'application Must-Gather
Ce sujet décrit l'utilisation de l'application Must-Gather. Must-Gather sert à collecter les informations de résolution des problèmes qui doivent être partagées avec HCL Support pour résoudre les problèmes HCL Commerce.
About this task
Procedure
- Assurez-vous que le conteneur Elasticsearch est opérationnel.
-
Pour accéder à l'API Must-Gather et à ses nœuds finaux à l'aide de l'interface utilisateur Swagger, vous devez effectuer les étapes suivantes.
-
Une fois que vous êtes en mesure d'accéder à l'API Must-Gather et à ses nœuds finaux à l'aide de l'une des URL d'interface utilisateur Swagger mentionnées à l'étape 2.c, utilisez le nœud final d'API Must-Gather souhaité pour effectuer la même exécution afin de collecter des données de dépannage. L'API Must-Gather dispose de nœuds finaux individuels pour chacun des services activés et d'un nœud final global pour collecter les données de résolution des problèmes de tous les services activés en une seule fois.
Important:
- Cette API et ses nœuds finaux ne sont pris en charge que lorsque HCL Commerce est déployé sur Kubernetes.
- Actuellement, Must-Gather n'est activé que pour les services de recherche tels que le service Query, le service Ingest, NiFi, Registry et Must-Gather (Configuration uniquement).
-
Fournissez des paramètres pour le nœud final afin de permettre à l'application Must-Gather de filtrer les journaux et d'extraire des données de résolution des problèmes depuis Elasticsearch. Chacun de ces nœuds finaux d'API Must-Gather, à l'exception de /search/elasticsearch, accepte les paramètres suivants.
Note:
- Aucun de ces paramètres n'est obligatoire.
- Ces paramètres peuvent être fournis dans n'importe quelle combinaison.
Nom du paramètre Utilisation traceId Ce paramètre permet d'obtenir les journaux de la requête spécifique uniquement.
Chaque fois que vous utilisez les nœuds finaux du service Query ou du service Ingest via l'interface utilisateur Swagger respective, vous recevez un traceId dans les en-têtes de réponse de la manière suivante :
Copiez ce traceId et fournissez-le dans le nœud final de l'API Must-Gather pour obtenir les journaux relatifs à cette requête spécifique uniquement.Important: Ce paramètre doit être utilisé en association avec le traçage de niveau API dans le service Query et le service Ingest pour de meilleurs résultats. Pour plus d'informations, voir Journalisation et identification et résolution des incidents des services Ingest et Query.fromDate et toDate Ces deux paramètres permettent de filtrer les journaux afin d'extraire des informations en fonction de la plage de dates fournie.
Prenez en compte les points suivants tout en fournissant les valeurs de ces deux paramètres:- La valeur de date est acceptée au format ISO8601, qui est aaaa-MM-dd.
- Si la valeur fromDate n'est pas fournie, la valeur par défaut est le jour qui précède la date actuelle.
- Si la valeur toDate n'est pas fournie, la valeur par défaut est la date actuelle.
- La valeur toDate ne peut pas être antérieure à la valeur fromDate. Elle doit toujours être ultérieure à fromDate.
- Si la valeur toDate est fournie, la valeur fromDate est obligatoire.
fromTime et toTime Ces deux paramètres permettent de filtrer les journaux afin d'extraire des informations en fonction de la plage de temps fournie.
Prenez en compte les points suivants tout en fournissant les valeurs de ces deux paramètres:- La valeur d'heure est acceptée au format HH:mm:ss (UTC).
- Si la valeur fromTime n'est pas fournie, elle est par défaut l'heure de minuit au début de la journée actuelle, à savoir "00:00".
- Si la valeur toTime n'est pas fournie, elle est par défaut l'heure juste avant minuit à la fin de la journée actuelle, à savoir 23:59:59.999999999.
- Si les valeurs fromDate et toDate sont identiques, la valeur toTime ne peut pas être antérieure à la valeur fromTime.
logLevel Ce paramètre permet de filtrer les journaux et d'extraire des informations en fonction des éléments logLevels dans lesquels les messages de journal sont générés à partir des services d'origine. getConfigs Par défaut, l'application Must-Gather extrait également les données de configuration des services activés respectifs. Vous pouvez choisir de désactiver cette option à l'aide de ce paramètre et d'extraire uniquement les journaux. Note:- Pour le service Query, les données de configuration suivantes sont actuellement extraites :
- Pour le service Ingest, les données de configuration suivantes sont actuellement extraites :
Note: Les détails d'exécution sont extraits en fonction de la plage de temps fournie pour fromTime et toTime. Seuls ces détails d'exécution sont renvoyés, dont l'horodatage est dans la plage horaire fromTime et toTime. - Pour Elasticsearch, la réponse des nœuds finaux suivants est recueillie :
http://<elasticsearchHost:elasticsearchPort>/_cat/indices?v&s=index http://<elasticsearchHost:elasticsearchPort>/_cat/shards?v http://<elasticsearchHost:elasticsearchPort>/_cluster/health?level=indices http://<elasticsearchHost:elasticsearchPort>/_cat/segments?v http://<elasticsearchHost:elasticsearchPort>/_aliases
-
Définissez la limite globale pour les documents extraits par service en réglant la variable d'environnement MAX_DOCS_PER_SERVICE dans le conteneur Docker.
Note: Si cette variable n'est pas définie, la limite par défaut des documents extraits par service est de 10 000 documents par service.
- Exécutez le nœud final d'API Must-Gather. Un fichier d'archive zip compressé contenant à la fois le journal et les données de configuration devient disponible au téléchargement.
- Partagez le fichier d'archive zip compressé avec HCL Support.