Use the SoS tool to collect the logs for various software components in the system.

About this task

The SoS tool collects logs from these components within your Cloud Foundation system:

  • Management, ToR, and inter-rack switches

  • SDDC Manager instances (the virtual machines in each rack with names starting with vrm), including the life cycle management (LCM) logs

  • HMS software component of SDDC Manager

  • Infrastructure virtual machines (ISVM VMs, including the Zookeeper and Cassandra service logs)

  • ESXi hosts

  • vCenter Server instances

  • Platform Services Controller instances

  • NSX Manager and NSX Controller instances

  • vRealize Log Insight instances deployed by SDDC Manager in the environment

  • Vitual machines used for the VDI workload domains' infrastructure, if any VDI workload domains exist in the environment

  • VIA virtual machine, if reachable on the network from the SDDC Manager instance where the SoS tool is invoked

Use these options when retrieving support logs from your environment's various components.

  • To collect all logs from all components except VDI-specific components, you can run the SoS tool without specifying any component-specific options.

  • To collect logs for a specific component, run the tool with the appropriate options.

Log files for the vRealize Log Insight agent in vCenter Server are collected when vCenter Server log files are collected.

After running the SoS tool, you can examine the resulting logs to troubleshoot issues, or provide to VMware Technical Support if requested. VMware Technical Support might request these logs to help resolve technical issues when you have submitted a support request. The diagnostic information collected using the SoS tool includes logs for the various VMware software components and software products deployed in your Cloud Foundation environment.

Procedure

  1. Using the root account, SSH to the SDDC Manager Controller VM.
  2. Change to the /opt/vmware/sddc-support directory.
  3. To collect the logs, run the SoS tool without specifying any component-specific options. To collect logs for a specific component, run the tool with the appropriate options.
    Note:

    By default, before writing the output to the directory, the tool deletes the prior run's output files that might be present. If you want to retain the older output files, specify the --no-clean-old-logs option.

    If you do not specify the --log-dir option, the tool writes the output to the /var/tmp directory in the SDDC Manager Controller VM.

    Table 1. SoS Tool Log File Options

    Option

    Description

    --api-logs

    Collects output from APIs.

    --cassandra-logs

    Collects logs from the Apache Cassandra database only.

    Apache Cassandra processes run in each of the infrastructure virtual machines, the ones with ISVM in their names. These ISVM VMs run in your installation's primary rack.

    --dump-only-sddc-java-threads

    Collects only the Java thread information from the SDDC Manager.

    --esx-logs

    Collects logs from the ESXi hosts only.

    --hms-logs

    Collects logs from the HMS software component only.

    --hms-host-debug-logs

    Collects HMS host debug logs only.

    --li-logs

    Collects logs from vRealize Log Insight VMs only.

    --no-audit

    Skips the audit executed as part of log collection.

    --no-clean-old-logs

    Use this option to prevent the tool from removing any output from a previous collection run. By default, the SoS tool.

    By default, before writing the output to the directory, the tool deletes the prior run's output files that might be present. If you want to retain the older output files, specify this option.

    --no-health-check

    Skips the health check executed as part of log collection.

    --nsx-logs

    Collects logs from the NSX Managerand NSX Controller instances only.

    --psc-logs

    Collects logs from the Platform Services Controller instances only.

    --sddc-manager-logs

    Collects logs from the SDDC Manager only.

    --switch-logs

    Collects logs from the switches only. Logs from all switches are collected: management, ToR, and, if a multirack installation, inter-rack switches.

    --test

    Collects test logs by verifying the files.

    --vc-logs

    Collects logs from the vCenter Server instances only.

    --vdi-logs

    Collects logs from VDI domains only.

    --via-logs

    When the VIA VMis reachable from the SDDC Manager Controller VM, you can use this option to collect logs only from the VIA virtual machine.

    --vm-screenshots

    Takes screen shots of all VMs.

    --zk-logs

    Collects logs from the Zookeeper server instances only.

    Zookeeper server processes run in each of the infrastructure virtual machines, the ones with ISVM in their names. These ISVM VMs run in your installation's primary rack. For more details about Zookeeper in the environment, see the VMware Cloud Foundation Overview and Bring-Up Guide.

    The tool displays Welcome to SoS log collection utility!, the output directory, sos.log file location, and messages about the tool's progress, for example:

    rack-1-vrm-1:/opt/vmware/sddc-support # ./sos --log-dir /home/sos-logs --vdi-pass VDIadminpwd
    Welcome to SoS(Supportability and Serviceability) utility!
    Logs: /home/sos-logs/sos-2016-10-26-19-54-48-8666
    Log file: /home/sos-logs/sos-2016-10-26-19-54-48-8666/sos.log
    Progress : 0%, Initiated log collection

Results

The tool collects the log files from the various software components in all of the racks and writes the output to the directory named in the --log-dir option. Inside that directory, the tool generates output in a specific directory structure.

The following example shows a sample output.

root@sddc-manager-controller [ /tmp/sos ]# ./sos
Welcome to Supportability and Serviceability(SoS) utility!
Logs : /var/tmp/sos-2017-09-13-17-29-51-8575
Log file : /var/tmp/sos-2017-09-13-17-29-51-8575/sos.log
Log Collection completed successfully for : [AUDIT, VIA, SDDC-MANAGER, SDDC-CASSANDRA, NSX_MANAGER, PSC, AUDIT LOG, ZOOKEEPER, API-LOGS, ESX, VDI, SWITCH, HMS, VMS_SCREENSHOT, VCENTER-SERVER, LOGINSIGHT, HEALTH-CHECK]

When the environment has more than one rack, the output includes directories for each rack, according to the naming pattern rack-1, rack-2, rack-3, and so on. .

What to do next

Change to the output directory to examine the collected log files.