virt-stats 3.0.0

This program is now deprecated.

This script is deprecated.

Machine Stats for Hypervisors (Virt-Stats)

A simple and effective way to gather guest VM statistics (hostname, IP addresses) from a libvirt-based environment as a first layer of a Tidal's discovery process. A common use case is to use this to integrate your KVM-based virtual machine inventory into the Tidal Accelerator Platform.

Prerequisutes

• Python 3+
• libvirt >=3.0.0 installed on both operator machine (i.e where you run Virt-Stats) and on remote machine (i.e where you run your virtual environmnent and guest VMs)

Installation

Install locally in a Python 3 environment:

python3 -m pip install virt-stats

Data captured

As of now Virt-Stats captures the following metrics:

• Hostname
• IP Addresses
• CPU count
• RAM allocated (GB)
• RAM used (GB)

Usage

virt-stats --connection URI

Please refer to the Connection URIs documentation for additional information.

Output

Virt-Stats outputs a JSON document suitable to be piped to Tidal Tools:

virt-stats --connection qemu+ssh://me@10.0.0.1/system | tidal sync servers

Troubleshooting

virt-stats: command not found

If running Virt-Stats as a CLI failed, try running it as the following:

python3 -m virt-stats

Contributing

If you're interested in contributing to Virt-Stats, please check our contributing guide.