Knowledge Base

The VMware Knowledge Base provides support solutions, error messages and troubleshooting guides
 
Search the VMware Knowledge Base (KB)   View by Article ID
 

Enabling or capturing performance statistics using Virtual SAN Observer for VMware Virtual SAN (2064240)

Purpose

This article provides steps to launch, collect and display Virtual SAN Observer (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 via a web browser and capture the statistics for customer use or for VMware Technical Support.

Resolution

  1. Log in to the Ruby vSphere Console (RVC) on your vCenter Server Appliance via SSH and run the command:

    rvc username@localhost

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

    %PROGRAMFILES%\VMware\Infrastructure\VirtualCenter Server\support\rvc\rvc.bat

  2. Enter the password for the user specified in step 1.
  3. Use the cd command to navigate to your vCenter Server directory, for example, localhost:

    cd localhost

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

    cd VSAN-DC

  5. To enable live monitoring for a cluster, run the command:

    Note: The cluster in this example is named VSAN-Cluster.

    vsan.observer ~/computers/VSAN-Cluster --run-webserver --force


  6. On a web browser, navigate to your vCenter Server hostname / IP Address with the port number specified in the output from step 6, for example on port 8010:

    https://vCenterServer_hostname_or_IP_Address:8010

Additional Information

Additional options for VSAN Observer

--filename

Or

-f
Output file path, for example, /tmp
--port

Or

-p
Port number for live statistics.

Note: The default port is 8010.
--run-webserver

Or

-r
Run the live statistics.
--force

Or

-o
Apply force.
--keep-observation-in-memory

Or

-k
Keep observed statistics in memory even when commands ends. This command allows you to resume later.
--generate-html-bundle

Or

-g
Generates an HTML bundle after completion. Pass a location.
--interval

Or

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

Note: The default value is 60.
--max-runtime

Or

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

Note: The default value is 2.
--forever

Or

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

Example:
vsan.observer ~/computers/VSAN --run-webserver --force --generate-html-bundle / --interval 30 --forever
--no-https

Or

-n
Don't use HTTPS and don't require a login. Useful if connection over HTTPS is not possible.

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

For example, 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 the command:

vsan.observer ~/computers/VSAN --run-webserver --force --generate-html-bundle /tmp --interval 30 --max-runtime 1

Note: To view live statistics when the command is running, navigate to your vCenter Server and specified port number using the URL:

http://vCenter_Server_IP_Address:Port_Number

See Also

Update History

01/15/2015 - Added 2 new options for VSAN Observer to the table in Additional Info section

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.

Feedback

  • 7 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)
  • 7 Ratings
Actions
KB: