csbench is a tool designed to evaluate the performance and efficiency of Apache CloudStack.

The tool is designed to be run from a single host, and can be used to benchmark a single CloudStack Zone.

As of now, there are two modes of operation:

1. Setting up environment with multiple domains, accounts, users, networks, VMs, etc.
2. Benchmarking a list of APIs against an existing CloudStack environment

1. Install go 1.20 or above. Follow instructions here to install golang.
2. Clone the repository
3. Build the binary using the below command. This will generate a binary named csbench in the current directory.

go build

Setup a config file. Check the sample config file here.

# URL of the CloudStack API endpoint
url = http://localhost:8080/client/api/
# Number of times to run the test. Used only for -benchmark
iterations = 1
# Page of results to start on. Used only for -benchmark
page = 0
# Max number of items to return per API call
pagesize = 5
# Zone to use for VMs. Used only for -create
zoneid = <zone id>
# Template to use for VMs. Used only for -create
templateid = <template id>
# Service offering to use for VMs. Used only for -create
serviceofferingid = <service offering id>
# Disk offering to use for volumes. Used only for -create
diskofferingid = <disk offering id>
# Shared network offering ID. Used only for -create
networkofferingid = <network offering id>
# Domain ID of the parent domain to create the subdomains under. Used only for -create
parentdomainid = <domain id>
# Number of domains to create. Creates a shared network for each domain. Used only for -create
numdomains = 2
# Number of VMs to create per domain. Used only for -create
numvms = 2
# Number of volumes to create & attach per VM. Used only for -create
numvolumes = 2

# Credentials to use to run -benchmark & -create. Name should be "admin" for -create
# Multiple profiles can be added and they will be used for -benchmark
[admin]
apikey = <api key>
secretkey = <secret key>
# Duration after which the signature included in the request is expired
expires = 600
# Signature version to allow the client to force a specific signature version
signatureversion = 3

$ csbench -h
Usage: go run csmetrictool.go -dbprofile <DB profile number>
Options:
  -benchmark
        Benchmark list APIs
  -config string
        Path to config file (default "config/config")
  -create
        Create resources
  -dbprofile int
        DB profile number
  -domain
        Create subdomains and accounts
  -format string
        Format of the report (csv, tsv, table). Valid only for create (default "table")
  -limits
        Update limits to -1 for subdomains and accounts
  -network
        Create shared network in all subdomains
  -output string
        Path to output file. Valid only for create
  -teardown
        Tear down all subdomains
  -vm
        Deploy VMs in all networks in the subdomains
  -volume
        Create and attach Volumes to VMs
  -workers int
        Number of workers to use while creating resources (default 10)

This mode of operation is designed to set up a CloudStack environment with multiple domains, accounts, users, networks and VMs as per the configuration file.

To execute this mode, run the following command followed by the type of resources to be created:

csbench -create -domain -limits -network -vm -volume

This will create the resources under the domain specified in the config file. If there are existing domains, network and VMs present under the domain, they will be used as well for creating the resources.

By default, the number of workers for executing the setup operation is 10. This can be changed by passing the -workers flag followed by the number of workers to be used.

By default the results of setting up the environment are printed out to stdout, if you want to save the results to a file, you can pass the -output flag followed by the path to the file. And use -format flag to specify the format of the report (csv, tsv, table).

By internally executing a series of APIs, this tool meticulously measures the response times for various users, page sizes, and keyword combinations. With its comprehensive benchmarking capabilities, csbench provides invaluable insights into the system's overall performance, allowing cloud administrators and developers to fine-tune their configurations for optimal efficiency and seamless user experiences.

Currently, it looks like

/csbench$ ./csbench -benchmark

Note: this tool will go through several changes and is under development.