HCL Commerce Version 9.1.7.0 or later

Uso de la aplicación Must-Gather

En este tema se describe el uso de la aplicación Must-Gather. Must-Gather sirve para recopilar la información de resolución de problemas que se necesita compartir con HCL Support para resolver los problemas de HCL Commerce.

About this task

Complete los siguientes pasos para recopilar los datos necesarios para la resolución de problemas mediante la aplicación Must-Gather.

Procedure

  1. Asegúrese de que el contenedor de Elasticsearch está en funcionamiento.
  2. Complete los siguientes pasos para acceder a la API de Must-Gather y a sus puntos finales mediante la interfaz de usuario Swagger.
    1. Inicie el contenedor de Must-Gather. 
      docker run -e LICENSE=accept -e LOG_ELASTICSEARCH_HOST=LOG_ELASTICSEARCH_HOST -e LOG_ELASTICSEARCH_PORT=LOG_ELASTICSEARCH_PORT -p 42020:42020 -p 42021:42021 9.1.6.0/commerce-mustgather:Image-Version
    2. Opcional: establezca variables de entorno opcionales o utilice sus valores por defecto. 
      NIFI_HOST, NIFI_PORT, REGISTRY_HOST, REGISTRY_PORT, DATA_QUERY_HOST, DATA_QUERY_PORT, AUTH_QUERY_HOST, AUTH_QUERY_PORT, LIVE_QUERY_HOST, LIVE_QUERY_PORT, INGEST_HOST, INGEST_PORT
      Important: Estas variables de entorno son necesarias para que la aplicación Must-Gather pueda extraer los datos de configuración de los servicios.
    3. Utilizando una de las siguientes URL, compruebe si puede acceder a Swagger UI para interactuar con la API de Must-Gather y sus puntos finales:
  3. Una vez que pueda acceder a la API Must-Gather y a sus puntos finales utilizando cualquiera de las direcciones URL de la interfaz de usuario Swagger mencionadas en el paso 2.c, utilice el punto final de la API Must-Gather deseado para ejecutar la misma con el fin de recopilar los datos de resolución de problemas. La API Must-Gather tiene puntos finales individuales para cada uno de los servicios habilitados y un punto final global para recopilar los datos de resolución de problemas de todos los servicios habilitados de una sola vez.
    Important:
    • Esta API y sus puntos finales solo son compatibles cuando HCL Commerce se despliega en Kubernetes.
    • Must-Gather está actualmente habilitado solo para los servicios de búsqueda como el servicio Query, el servicio Ingest, Nifi, Registry y Elasticsearch (solo en la configuración).
  4. Proporcione los parámetros del punto final para que la aplicación Must-Gather pueda filtrar los registros y recuperar los datos de resolución de problemas de Elasticsearch. Cada uno de estos puntos finales de API must-gather, excepto /search/elasticsearch,acepta los parámetros siguientes.
    Note:
    • Ninguno de estos parámetros es obligatorio.
    • Estos parámetros pueden proporcionarse en cualquier combinación.
    Nombre de parámetro Usage
    traceId

    Este parámetro ayuda a obtener solo los registros de la solicitud específica.

    Siempre que utilice los puntos finales del servicio Query o del servicio Ingest a través de la respectiva interfaz de usuario swagger, recibirá un traceid en las cabeceras de respuesta de la siguiente manera:

    Copie este traceid y proporciónelo en el punto final de la API de Must-Gather para obtener los registros correspondientes solo a esa solicitud específica.
    Important: Este parámetro debe utilizarse en combinación con el rastreo a nivel de API en el servicio Query y el servicio Ingest para obtener los mejores resultados. Para más detalles, consulte Registrar y solucionar problemas de los servicios de recopilación y consulta.
    fromDate y toDate

    Estos dos parámetros ayudan a filtrar los registros para recuperar la información basada en el rango de fechas proporcionado.

    Tenga en cuenta los puntos siguientes al proporcionar los valores para estos dos parámetros:
    • El valor de la fecha se acepta en formato ISO8601 que es aaaa-MM-dd.
    • Si no se proporciona el valor de fromDate, por defecto será el día anterior a la fecha actual.
    • Si no se proporciona el valor de toDate, por defecto será la fecha actual.
    • El valor de toDate no puede ser anterior a fromDate. Siempre debe ser mayor que fromDate.
    • Si se proporciona el valor toDate, es obligatorio proporcionar el valor fromDate.
    fromTime y toTime

    Estos dos parámetros ayudan a filtrar los registros para recuperar la información basada en el rango de tiempo proporcionado.

    Tenga en cuenta los puntos siguientes al proporcionar los valores para estos dos parámetros:
    • El valor de la hora se acepta en formato HH:mm:ss (UTC).
    • Si no se proporciona el valor de fromTime, por defecto, se toma la hora de medianoche del inicio del día actual, que es "00:00".
    • Si no se proporciona el valor de toTime, por defecto será la hora justo antes de la medianoche del final del día actual, que es 23:59:59.999999999.
    • Si los valores fromDate y toDate son iguales, el valor toTime no puede ser anterior al valor fromTime.
    logLevel Este parámetro ayuda a filtrar los registros y a recuperar la información basándose en los logLevel en los que se generan los mensajes de registro desde los servicios de origen.
    getConfigs Por defecto, la aplicación Must-Gather también extrae los datos de configuración de los respectivos servicios habilitados. Puede optar por desactivar esta opción mediante este parámetro y extraer solo los registros.
    Note:
    • Para el servicio Query, actualmente se extraen los siguientes datos de configuración:
    • Para el servicio Ingest, actualmente se extraen los siguientes datos de configuración:
      Note: Los detalles de la ejecución se recuperan basándose en el rango de tiempo proporcionado para fromTime y toTime. Solo se devuelven los detalles de la ejecución cuya marca de tiempo está dentro del rango de tiempo fromTime y toTime.
    • En el caso de Elasticsearch, se recoge la respuesta de los siguientes puntos finales:
      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
  5. Establezca el límite global de documentos recuperados por servicio fijando la variable de entorno MAX_DOCS_PER_SERVICE en el contenedor Docker.
    Note: Si esta variable no se establece, el límite predeterminado para los documentos recuperados por servicio es de 10000 documentos por servicio.
  6. Ejecute el punto final de la API Must-Gather. Un archivo comprimido que contiene el registro y los datos de configuración estará disponible para su descarga.
  7. Comparta el archivo comprimido en zip con HCL Support.