Collecting MustGather data for base catalog data import issues

Collect the following MustGather information before you call HCL Support to help with Catalog PBC issues.

About this task

Collect MustGather data for the following troubleshooting scenarios:
  • Catalog Service administrative APIs: Collect MustGather data to troubleshoot issues with the commerce-plus-catalog-service admin APIs. For more information, see MustGather data for the Catalog Service.
  • Base catalog data import: Use the following procedure to collect MustGather data for troubleshooting base catalog data import issues.

MustGather for base catalog imports

Procedure

  1. Collect the following information for every import issue before opening or escalating a support ticket:
    • Job ID
    • Request header values
    • Input files used for the import
    • Response from the GET /admin/v1/data-jobs/import/{jobId} API
    • Log entries for the Job ID that capture the complete import lifecycle
    • Pod events and pod restart history for suspected out-of-memory (OOM) issues
  2. Configure the following trace strings.
    Component Trace string
    Logging Aspect (for entry/exit tracing of all methods) 
    com.hcl.catalog.logging
    All Catalog Logs 
    com.hcl.catalog
    Exception Logs 
    com.hcl.catalog.exception
    Utility Logs 
    com.hcl.catalog.util
    Admin-API framework Logs 
    com.hcl.commerce.cf
    You can dynamically enable TRACE-level logging for the com.hcl.catalog package without restarting the Catalog server by using the logger API.
    • Enable TRACE Logging:
      • Send a POST request to the following endpoint:
        POST {{catalog-url}}/catalog/api/actuator/loggers/com.hcl.catalog
with json body:
{
    "configuredLevel":"TRACE"
}
    • List Logging Levels:
      • To list the logging levels for all packages on the Catalog server, you can call the following API:

        GET {{catalog-url}}/catalog/api/actuator/loggers

    The catalog container will generate logs in the default log directory, /var/tmp/logs. If logs are not being generated there, verify the exact log directory path (catalog.log.dir) in the /SETUP/app/logback-spring.xml file:

    <property name="LOGS" value="/var/tmp/logs" />