Collecting log packages for IBM Fusion HCI

You can create your log package by using one or more component logs.

Procedure

  1. From the title bar, click the help icon and select Support logs.
  2. In the Support logs page, click Collect logs.
    The Create a log package page gets displayed.
  3. In the Create a log package page, select one or more components to create the log package. The log package contains the folders, namespaces, and relevant files. For more guidance on the log package, see Log package.
    System logs
    System logs contains the information about the operation, status, and potential issues of the system health and administration in the IBM Fusion HCI.
    System health check
    Use this option to collect logs that provide an overall assessment of the health of IBM Fusion HCI. This log package includes the following information:
    • The health of the components that make up the IBM Fusion HCI.
    • The health of IBM Fusion services such as the Global Data Platform and Backup & Restore.
    • The health of the IBM Fusion HCI operator
    • The Red Hat® OpenShift® configuration of Bare Metal hosts, machine sets, machines, and nodes.
    Administration
    Use this option to collect logs related to Red Hat OpenShift, administration, and audit logging.
    Hardware logs
    Hardware logs contains the information about the operation, status, and potential issues of the hardware components such as nodes, service node, and switches in the IBM Fusion HCI.
    Nodes
    Using this option to collect logs for the nodes in the IBM Fusion HCI appliance. Troubleshoot issues related to node health, firmware upgrades, storage configuration, Metro-DR, and Regional DR configurations. For example, issues like offline nodes and issues with firmware upgrade.
    Network switches
    Use this option to collect logs for the switches in the IBM Fusion HCI appliance. Troubleshoot issues related to the IBM Fusion HCI network. The logs that are collected in this package include information on the switches, Vlans, and links that make up the appliance network. For example, issues like network outages, degraded performance, connecting the IBM Fusion HCI appliance to the data center network, and problems related to Metro-DR recovery.
    Attention: Network switches log collection package does not include the spine switches logs.
    Software and services
    Software and services logs contains the information about the operation, status, and potential issues of the services such as Global Data Platform, IBM Data Cataloging, Backup & Restore, and Data Foundation in the IBM Fusion HCI.
    Global Data Platform
    Important:
    • Enable scale traces before you collect the Global Data Platform logs. For more information about how to enable traces, see Generating GPFS trace reports.
    Use this option to collect logs related to the physical storage configuration of IBM Fusion HCI and Global Data Platform. These logs are used to troubleshoot storage issues. For example, issues like loss of storage access, problems with CSI provisioning, problems related to disaster recovery (Metro-DR and Regional DR), problems with the overall health of the Global Data Platform.
    Backup & Restore
    Use this option to collect logs related to the Backup & Restore service. These logs are used to troubleshoot issues that are related to setup, backup, and restore. These logs contain mainly the ibm-backup-restore namespace resources.
    For Backup & Restore service, you can also select logs for the specific clusters as follows:
    1. In the Summary slide out pane, click edit icon next to Backup & Restore.

      The Select spoke clusters page gets displayed with all the available clusters.

    2. Select the spoke clusters that you want to include in the log package.
      Important:
      • You can collect logs for spokes from Hub by selecting the spoke clusters from the Hub IBM Fusion HCI user interface.
      • The logs can also be collected from the individual Spoke clusters.
    Backup & Restore agent
    Use this option to collect logs related to the Backup & Restore service on the spoke cluster. These logs are used to troubleshoot issues that are related to setup, backup, and restore. These logs contain mainly the ibm-backup-restore namespace resources.
    IBM Data Cataloging
    Use this option to collect logs that are related to the IBM Data Cataloging service. These logs contain mainly the ibm-data-cataloging namespace resources.
    Data Foundation
    Use this option to collect logs that are related logs related to Kubernetes resources of openshift-local-storage, openshift-storage-client, openshift-lvm-storage, and openshift-storage.
    Important: If a service is not enabled, the user interface does not display the service component in the log collection.
  4. Click Create.
    The created log package gets added to the log list with status as Collecting. After the collection is complete, the status changes to Success.

    The log package creation might take several minutes and the amount of time might vary based on the type of logs collected. You can view the progress of the log package creation in the table that is shown on the Supported logs page.

    The Support logs page lists all created log packages with the following details:
    Name
    The name of the log package.
    Note: The name of the log package consists of two parts: component name and timestamp. For example, in a nodes package, the file name must be cn-20220324124442. The name of the log package change for every component.
    • Global Data Platform: gdp
    • System heath check: sh
    • Administration: ad
    • Network: nw
    • Data foundation: odf
    Contents
    It contains details of which component logs comprise the log package.
    Status
    The values of the status field are Collecting, Success, and Partial.
    Note: The Partial status means that some of the requested logs are collected successfully, but there are error messages that are generated in the process.
    Created
    The date and time of the creation of the log package.
    Expires
    The expiry date and time of the log set.
    Note: The collected log packages are auto-deleted after 24 hours.
  5. After a log package is successfully added to the log list, you can upload it to IBM directly by using the Call Home feature, download it to your local, or delete it.
    Upload the collected log package to IBM Support
    If Call Home is enabled, you can use the IBM Fusion HCI user interface to automatically upload logs to a ticket. For steps to enable call home, see Enabling IBM Call Home for IBM Fusion HCI.
    1. Click the ellipsis menu of the log record and click Upload log package to IBM via Call Home.
      The Upload log package window gets displayed. The collected logs get uploaded so that the IBM Support team can use for diagnosis.
    2. In the Upload log package window, choose whether you want to create a new support case or attach to an existing case.
    3. If it is an existing case, then enter the Ticket number.
      Note: A log collection package can be uploaded only once to any ticket through this user interface page.
    4. Click Upload log.
    Download collected log package
    Click the ellipsis menu of the log record and click Download. The Downloading log package window gets displayed indicating that the download is in progress.
    Delete a log package
    1. Click the ellipsis menu of the log record and click Delete.
    2. In the Confirm delete log package window, click Delete.
    If you did not enable Call Home, then download the log package and upload it to an IBM site. In the table of log packages, click the ellipsis menu for the log package that you want to upload and select the Download action. It triggers the download of the log package file in your web browser. The user interface provides three methods of uploading logs to IBM.
    FTP transfer
    This option is the fastest approach to upload logs to IBM. It uses FTP to upload logs to the IBM Enhanced Customer Data Repository (ECUREP) site.
    Browser upload
    Using the browser upload option, upload the log package from your web browser. This option is limited to files that are smaller than 200 MiB.
    Blue Diamond
    HIPPA customers designated as Blue Diamond must upload logs to the IBM Blue Diamond site.

What to do next

  1. After a log package is successfully completed, you can check the folders, namespaces, and relevant files of the log package to read and troubleshoot. See Log package.