Skip to main content
HCI
1.10

Collect logs for troubleshooting

Contributors amgrissino netapp-dbagwell netapp-pcarriga netapp-yvonneo netapp-mwallis
PDFs

If you have trouble with your NetApp HCI or SolidFire all-flash storage installation, you can collect logs to send to NetApp Support to help with diagnosis. You can either use NetApp Hybrid Cloud Control or the REST API to collect logs on NetApp HCI or Element systems.

What you'll need

  • Ensure that your storage cluster version is running NetApp Element software 11.3 or later.

  • Ensure that you have deployed a management node running version 11.3 or later.

Log collection options

Choose one of the following options:

Use NetApp Hybrid Cloud Control to collect logs

You can access the log collection area from the NetApp Hybrid Cloud Control Dashboard.

Steps

  1. Open the IP address of the management node in a web browser. For example:

    https://<ManagementNodeIP>

  2. Log in to NetApp Hybrid Cloud Control by providing the NetApp HCI or Element storage cluster administrator credentials.

  3. From the Dashboard, click the menu on the upper right.

  4. Select Collect Logs.

    The Collect Logs page appears. If you have collected logs before, you can download the existing log package, or begin a new log collection.

  5. Select a date range in the Date Range drop-down menu to specify what dates the logs should include.

    If you specify a custom start date, you can select the date to begin the date range. Logs will be collected from that date up to the present time.

  6. In the Log Collection section, select the types of log files the log package should include.

    For storage and compute logs, you can expand the list of storage or compute nodes and select individual nodes to collect logs from (or all nodes in the list).

  7. Click Collect Logs to start log collection.

    Log collection runs in the background, and the page shows the progress.

    Note Depending on the logs you collect, the progress bar might remain at a certain percentage for several minutes, or progress very slowly at some points.

  8. Click Download Logs to download the log package.

    The log package is in a compressed UNIX .tgz file format.

Use the REST API to collect logs

You can use REST API to collect NetApp HCI or Element logs.

Steps

  1. Locate the storage cluster ID:

    1. Open the management node REST API UI on the management node:

      https://<ManagementNodeIP>/logs/1/

    2. Click Authorize and complete the following:

      1. Enter the cluster user name and password.

      2. Enter the client ID as mnode-client if the value is not already populated.

      3. Click Authorize to begin a session.

  2. Collect logs from NetApp HCI or Element:

    1. Click POST /bundle.

    2. Click Try it out.

    3. Change the values of the following parameters in the Request body field depending on which type of logs you need to collect and for what time range:

      Parameter Type Description

      modifiedSince

      Date string

      Only include logs modified after this date and time. For example, the value "2020-07-14T20:19:00.000Z" defines a start date of July 14, 2020 at 20:19 UTC.

      computeLogs

      Boolean

      Set this parameter to true to include compute node logs.

      computeIds

      UUID array

      If computeLogs is set to true, populate this parameter with the management node asset IDs of compute nodes to limit log collection to those specific compute nodes. Use the GET https://<ManagementNodeIP>/logs/1/bundle/options endpoint to see all possible node IDs you can use.

      mnodeLogs

      Boolean

      Set this parameter to true to include management node logs.

      storageCrashDumps

      Boolean

      Set this parameter to true to include storage node crash debug logs.

      storageLogs

      Boolean

      Set this parameter to true to include storage node logs.

      storageNodeIds

      UUID array

      If storageLogs is set to true, populate this parameter with the storage cluster node IDs to limit log collection to those specific storage nodes. Use the GET https://<ManagementNodeIP>/logs/1/bundle/options endpoint to see all possible node IDs you can use.

    4. Click Execute to begin log collection.
      The response should return a response similar to the following:

      {
  "_links": {
    "self": "https://10.1.1.5/logs/1/bundle"
  },
  "taskId": "4157881b-z889-45ce-adb4-92b1843c53ee",
  "taskLink": "https://10.1.1.5/logs/1/bundle"
}

  3. Check on the status of the log collection task:

    1. Click GET /bundle.

    2. Click Try it out.

    3. Click Execute to return a status of the collection task.

    4. Scroll to the bottom of the response body.

      You should see a percentComplete attribute detailing the progress of the collection. If the collection is complete, the downloadLink attribute contains the full download link including the file name of the log package.

    5. Copy the file name at the end of the downloadLink attribute.

  4. Download the collected log package:

    1. Click GET /bundle/{filename}.

    2. Click Try it out.

    3. Paste the file name you copied earlier into the filename parameter text field.

    4. Click Execute.

      After execution, a download link appears in the response body area.

    5. Click Download file and save the resulting file to your computer.

      The log package is in a compressed UNIX .tgz file format.

Find more information