Search the VMware Knowledge Base (KB)
View by Article ID

How to capture performance statistics using VSAN Observer (2064240)

  • 14 Ratings


This article provides steps to launch, collect, and display Virtual SAN (VSAN) Observer performance charts and information for VMware Virtual SAN.

VSAN Observer is designed to capture performance statistics for a Virtual SAN Cluster and provide access through a web browser and capture the statistics for customer use or for VMware Technical Support.


VSAN Observer is a feature of the Ruby vSphere Console (RVC).

To launch VSAN Observer:
  1. Log in to the Ruby vSphere Console (RVC) on your vCenter Server Appliance through SSH and run this command:

    rvc username@localhost

    Note: For vCenter Server running on Windows, run this batch file to launch RVC:

    • For VSAN 6.x: %PROGRAMFILES%\VMware\vCenter Server\rvc\rvc.bat
    • For VSAN 5.5: %PROGRAMFILES%\VMware\Infrastructure\VirtualCenter Server\support\rvc\rvc.bat

  2. Enter the user password, if prompted.
  3. Run the cd command to navigate to your vCenter Server directory.
    For example, localhost:

    cd localhost

  4. Run the cd command to navigate to the data center for your Virtual SAN environment.
    For example, VSAN-DC:

    cd VSAN-DC

  5. Run this command to enable live monitoring for a cluster:

    Note: The cluster in this example is named VSAN-Cluster. ~/computers/VSAN-Cluster --run-webserver --force

  6. To view the live statistics in a web browser, point the browser URL to your vCenter Server hostname / IP Address with the port number specified in the output of step 5.

     For example, on port 8010:


Additional Information

Additional options for VSAN Observer



Output file path. For example, /tmp.


Port number for live statistics.

Note: The default port is 8010.


Run the live statistics.


Apply force.


Keep observed statistics in memory even when commands ends. This command allows you to resume later.


Generates an HTML bundle after completion. Pass a location.


Interval value (in seconds) in which to collect statistics.

Note: The default value is 60.


Maximum number of hours to collect statistics. This command caps memory usage.

Note: The default value is 2.


Runs until stopped. Every --max-runtime intervals retires a snapshot to disk. Pass a location.

Example: ~/computers/VSAN --run-webserver --force --generate-html-bundle / --interval 30 --forever


Does not use HTTPS and does not require a login. Useful if connection over HTTPS is not possible.

Warning: Insecure, only use if connection over https is not possible.


To generate a performance statistics bundle over a one hour period at 30 second intervals for a VSAN cluster named VSAN and save the generated statistics bundle to the /tmp folder, run this command: ~/computers/VSAN --run-webserver --force --generate-html-bundle /tmp --interval 30 --max-runtime 1

For assistance in calculating a maximum IOPS value and checking if your SSD is a performance bottleneck, use VSAN calculator spreadsheet which is available in the attached file.


VSAN Observer, Ruby vSphere Console, performance statistics

See Also

Update History

01/15/2015 - Added 2 new options for VSAN Observer to the table in Additional Info section 03/12/2015 - Added Virtual SAN 6.0 to Products. 08/09/2016 - Added Virtual SAN 6.1 and 6.2 to Products. 08/10/2016 - mkhalil - Corrected URL to use https only.


Request a Product Feature

To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.


  • 14 Ratings

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.

What can we do to improve this information? (4000 or fewer characters)

Please enter the Captcha code before clicking Submit.
  • 14 Ratings