Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

vrops-export

Simple utility for exporting data from vRealize Operations.

Description

A simple command-line data export tool for vRealize Operations. Currently, the tool supports CVS, JSON, ElasticSearch, Wavefront and SQL, but additional output formats are planned.

Installation

The tool can be installed from pre-built binaries or built from source. If you're unclear what "building from source" means, you probably want to use the binaries. Building from source is mainly for people who like to change the code and contribute to the project.

Installing the binaries

Prerequisites

  • Java JDK 1.8 installed on the machine where you plan to run the tool
  • vRealize Operations 6.3 or higher

Installation on Linux, Mac or other UNIX-like OS

  1. Download the binaries from here: https://github.com/vmware/vrops-export/releases
  2. Unzip the files:
mkdir ~/vrops-export
cd ~/vrops-export
unzip vrops-export-<version>-bin.zip
cd vrops-export-<version>/bin
  1. Make the start script runnable
chmod +x exporttool.sh
  1. Run it!
./exporttool.sh -d ../samples/vmfields.yaml -u admin -p password -H https://my.vrops.host

Installation on Windows

  1. Download the binaries from here: https://github.com/vmware/vrops-export/releases
  2. Unzip the files into a directory of your choice, e.g. c:\vropsexport
  3. Open a command window and cd into the directory you created, e.g.
cd c:\vropsexport
  1. Cd into the bin directory
cd bin
  1. Runt the tool
exporttool.bat -d ..\samples\vmfields.yaml -u admin -p password -H https://my.vrops.host

Building from source

Prerequisites

  • Java JDK 1.8 installed on the machine where you plan to run the tool
  • vRealize Operations 6.3 or higher
  • Maven 3.3.3 or higher

Build

  1. Get from git
git init # Only needed of you haven't already initialized a git repo in the directory 
git clone https://github.com/vmware/vrops-export.git
  1. Build the code
cd vrops-export
mvn package
  1. Run it!
cd target
chmod +x exporttool.sh
./exporttool.sh -d ../samples/vmfields.yaml -u admin -p password -H https://my.vrops.host -i

Command syntax

usage: exporttool [-d <arg>] [--dumprest] [-e <arg>] [-F <arg>] [-G <arg>]
       [-H <arg>] [-h] [-i] [-l <arg>] [-m <arg>] [-n <arg>]
       [--no-sniextension] [-o <arg>] [-P <arg>] [-p <arg>] [-q] [-r
       <arg>] [-R <arg>] [--resfetch <arg>] [-s <arg>] [-S] [-t <arg>] [-T
       <arg>] [--trustpass <arg>] [-u <arg>] [-v]
Exports vRealize Operations Metrics
 -A,--adapter-kinds          List adapter kinds
 -d,--definition <arg>       Path to definition file
    --dumprest               Dump rest calls to output
 -e,--end <arg>              Time period end (date format in definition
                             file)
 -F,--list-fields <arg>      Print name and keys of all fields to stdout
 -G,--generate <arg>         Generate template definition for resource
                             type
 -H,--host <arg>             URL to vRealize Operations Host
 -h,--help                   Print a short help text
 -i,--ignore-cert            Trust any cert (DEPRECATED!)
 -l,--lookback <arg>         Lookback time
 -m,--max-rows <arg>         Maximum number of rows to fetch
                             (default=1000*thread count)
 -n,--namequery <arg>        Name query
    --no-sniextension        Disable SNI extension. May be needed for very
                             old SSL implementations
 -o,--output <arg>           Output file
 -P,--parent <arg>           Parent resource (ResourceKind:resourceName)
 -p,--password <arg>         Password
 -q,--quiet                  Quiet mode (no progress counter)
 -r,--refreshtoken <arg>     Refresh token
 -R,--resource-kinds <arg>   List resource kinds
    --resfetch <arg>         Resource fetch count (default=1000)
 -s,--start <arg>            Time period start (date format in definition
                             file)
 -S,--streaming              True streaming processing. Faster but less
                             reliable
 -t,--threads <arg>          Number of parallel processing threads
                             (default=10)
 -T,--truststore <arg>       Truststore filename
    --trustpass <arg>        Truststore password (default=changeit)
 -u,--username <arg>         Username
 -v,--verbose                Print debug and timing information

Certificate and trust management

As of version 2.1.0, the -i option has been deprecated for security reasons. Instead, the tool will prompt the user when it encounters an untrusted certificate. If the user chooses to trust the certificate, it is stored in a personal truststore and reused next time the tool is executed against that host. By default, the trusted certs are stored in $HOME/.vropsexport/truststore, but the location can be overridden using the -T flag.

TLS handshake issues

In some cases, especially with very old SSL/TLS implementations, you may see name verification errors. To remedy this, please try the --no-sniextension command-line argument.

Authentication

The vrops-export tool uses the local authentication source by default. Other sources can be specified by using the " username@source" syntax. Be aware that in the case of e.g. Active Directory, the string after the @-sign should be the name of the authentication source and not that of the Active Directory domain.

Support for vRealize Operations Cloud

As of version 3.2.0, vRealize Operations Cloud is supported. To export data from a cloud instance, use the following API endpoind URLs as arguments to the -H option:

United States: https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api

All other countries: https://<country>.www.mgmt.cloud.vmware.com/vrops-cloud/suite-api Where country is the country code of your API endpoint. Should match the country code in your browser URL when interacting with vRealize Operations Cloud.

Use the -r option to log in using a refresh token/API token.

Notes:

  • Start and end dates will use the date format specified in the definition file. Since dates tend to contain spaces and special characters, you probably want to put dates within double quotes (").
  • If you're unsure of what the metric names are, use the -F option to print the metric names and keys for a specific resource type, e.g. -F VirtualMachine
  • The -l (lookback) parameter is an alternative to the start and end dates. It sets the end date to the current time and goes back as far as you specify. You specify it as a number and a unit, e.g. 24h for 24 hours back. Valid unit are d=days, h=hours, m=minutes, s=seconds.
  • The -P flag restricts the export to objects sharing a specified parent. Parents must be specified as resource kind and resource name, for example HostSystem:esxi-01 if you want to export only VMs on the host named "esxi-01".

Definition file

The details on what fields to export and how to treat them is expressed in the definition file. This file follows the YAML format. Here is an example of a definition file:

resourceType: VirtualMachine                     # The resource type we're exporting
rollupType: AVG                                  # Rollup type: AVG, MAX, MIN, SUM, LATEST, COUNT
rollupMinutes: 5                                 # Time scale granularity in minutes
dateFormat: yyyy-MM-dd HH:mm:ss                  # Date format. See http://tinyurl.com/pscdf9g
fields:                                          # A list of fields
# CPU fields
 - alias: cpuDemand                             # Name of the field in the output
   metric: cpu|demandPct                        # Reference to a metric field in vR Ops
 - alias: cpuReady
   metric: cpu|readyPct
 - alias: cpuCostop
   metric: cpu|costopPct
# Memory fields
 - alias: memDemand
   metric: mem|object.demand
 - alias: memSwapOut
   metric: mem|swapoutRate_average
 - alias: memSwapIn
   metric: mem|swapinRate_average
# Storage fields
 - alias: storageDemandKbps
   metric: storage|demandKBps
# Network fields
 - alias: netBytesRx
   metric: net|bytesRx_average
 - alias: netBytesTx
   metric: net|bytesTx_average
# Host CPU
 - alias: hostCPUDemand
   metric: $parent:HostSystem.cpu|demandmhz	# Reference to a metric in the parent. 
# Guest OS
 - alias: guestOS
   prop: config|guestFullName			# Reference to a property (as opposed to metric)
# Host CPU type
 - alias: hostCPUType
   prop: $parent:HostSystem.cpu|cpuModel		# Reference to a metric in a parent
# A vCenter tag
 - alias: costcenter
   tag: costcenter

Global directives

  • resourceType: Name of the resource type (e.g. VirtualMachine)
  • rollupType: Type of data aggregation. Valid values are MAX, MIN, AVG, SUM, LATEST.
  • rollupMinutes: Number of minutes in each bucket for rollup. E.g. rollupType: "AVG" and rollupMinutes: 5 generates 5-minute averages.
  • dateFormat: Format to use when specifying and displaying dates. See http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html for a description of the format. In addition, the format string"%E" will cause the tool to output raw epoch milliseconds as dates.
  • outputFormat: Specifies the output format. Valid values are csv, json, wavefront and sql.
  • align: Aligns the timestamps to a specified granularity (in seconds). For example, if an align value of 300 is specified, all timestamps will be aligned to the nearest 5 minutes. Note that only the time stamps are changed. Interpolation is not yet supported.
  • allMetrics: Exports all metrics for every resource. This option is intended mainly for the JSON output format and will most likely not work for table-oriented outputs, such as CSV and SQL. If specified, the fields attribute is ignored.

Field properties

  • alias: The name of the field as it will appear in the output
  • prop: Name of a property on the resource from which the value is fetched.
  • metric: Name of a metric on the resource from which the value is fetched.
  • tag: Name of a vCenter tag category on the resource from which the value is fetched.

Special properties in the definition file

There are a number of special properties that are always available for use in a properties file for getting things like parent resources and resource names.

  • $resId - Internal ID of the current resource.
  • $resName - Resource name of the current resource
  • $parent - Reference to a parent resource.

Referencing parent resources

The syntax for referencing parent resources is as follows:

$parent:<Parent Kind>.<metric or property>

For example:

$parent:HostSystem.cpu|demandmhz

Notice that you can stack several $parent keywords. For example, this gets the total CPU demand of a parent cluster based on a VM:

$parent:HostSystem.$parent:ClusterComputeResource.cpu|demandmhz

Exporting to SQL

The tool supports exporting to a SQL database. For details, please refer to this document

Exporting to Wavefront

For information on exporting to Wavefront, please refer to this document

Exporting to JSON

For information on exporting to JSON, please refer to this document

Known issues

  • Very long time ranges in combination with small interval sizes can cause the server to prematurely close the connection, resulting in NoHttpResponseExceptions to be thrown. If this happens, consider shortening the time range. This seems to happen mostly when exporting over a slow connection.
  • Only one parent resource type is supported. This will be fixed in a future release.

Contributing to the code

Contributing with code and new ideas is encouraged! If you have a great idea for a new or improved feature, please file a feature request under the "issues" tab in Github.