Skip to main content

Collect log files and system data

Contributors netapp-lhalbert netapp-pcarriga
PDFs

You can retrieve StorageGRID log files and system data, including configuration data, and send them to technical support.

Before you begin
About this task

Use the Grid Manager to gather log files, system data, and configuration data from any grid node for the time period that you select. Data is collected and archived in a .tar.gz file that you can then download to your local computer or send to technical support.

Optionally, you can change the destination of audit logs and send audit information to an external syslog server. Local logs of audit records continue to be generated and stored when an external syslog server is configured. See Configure log management and external syslog server.

Steps

  1. Select Support > Tools > Log collection. A table of nodes displays.

  2. Select the grid nodes for which you want to collect log files.

    You can sort by node name, site, and node type. The Site and Node type columns contain filters for selecting by individual sites and node types.

  3. Select Continue.

  4. Select the date and time range of the data to be included in the log files.

    If you select a very long time period or collect logs from all nodes in a large grid, the log archive could become too large to be stored on a node, or too large to be collected by an Admin Node for download. If either scenario occurs, restart log collection with a smaller set of data.

  5. Select the types of logs you want to collect.

    • Application logs: Application-specific logs that technical support uses most frequently for troubleshooting. The logs collected are a subset of the available application logs.

    • Audit logs: Logs containing the audit messages generated during normal system operation.

    • Network trace: Logs used for network debugging.

    • Prometheus database: Time series metrics from the services on all nodes.

  6. Optionally, use the Notes text box to enter notes about the log files you are gathering.

    You can use these notes to give technical support information about the problem that prompted you to collect the log files. Your notes are added to a file called info.txt, along with other information about the log file collection. The info.txt file is saved in the log file archive package.

  7. In the Provisioning passphrase text box, enter the provisioning passphrase for your StorageGRID system.

  8. Select Collect logs.

    You can use the Log collection page to monitor the progress of log file collection for each grid node.

    If you receive an error message about log size, try collecting logs for a shorter time period or for fewer nodes.

  9. If log collection fails:

    • If a "Log collection failed" message appears, you can retry the log collection or finish the session without retrying.

    • If a "Log collection partially failed" message appears, you can retry the log collection, finish the session, download the partial log file, or send the partial log file to AutoSupport.

  10. When log file collection is complete:

    • Select Download to download the .tar.gz file.

    • Select Send to AutoSupport to send the .tar.gz file to technical support.

      The .tar.gz file contains all log files from all grid nodes where log collection was successful. The combined .tar.gz file contains one log file archive for each grid node.

      The subject of the AutoSupport package is USER_TRIGGERED_SUPPORT_BUNDLE.

  11. Select Finish.

    Caution The .tar.gz file is deleted when you select Finish. Make sure you download or send the file first.