From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search
Zenoss, Inc.
GNU General Public License, Version 2, or later
ZenPack name
More Information
GitHub page/HomePage
Link to more docs
View Documentation
Git sources (for cloning)

Applications Monitored: 

CloudStack ZenPack

Monitor CloudStack


The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.


This is an Open Source ZenPack developed by Zenoss, Inc. Enterprise support for this ZenPack is available to commercial customers with an active subscription.


Version 1.2.0- Download
Released on 2016/01/25
Compatible with Zenoss Core 4.2.x, Zenoss Core 5.0.x, Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x
Version 1.1.3- Download
Released on 2015/03/05
Compatible with Zenoss Core 4.2.x, Zenoss Core 5.0.x, Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x
Version 1.0.9- Download
Released on 2013/04/24
Compatible with Zenoss Core 3.2.x, Zenoss Core 4.2.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x


Monitoring for Apache CloudStack and by extension, Citrix CloudPlatform.

The easiest way to start monitoring CloudStack is to navigate to the Infrastructure page, click the *+* menu to add a device and choose Add CloudStack. Fill out the Device to Create, URL, API Key, and Secret Key fields, select a collector, then click OK. The URL should only include the protocol, host and port (i.e. http://cloudstack.example.com/). You can find or create the keys by logging into the CloudStack web interface and navigate to Accounts and users.

Zenoss will then add the CloudStack device to the system. For root administrator users, the associated zones, pods, clusters, hosts, routers, system VMs and VMs will also be added; zones, routers and VMs for domain administrator users; zones and VMs for all non administrator users. Monitoring will also start after the discovery is complete.

Upgrade Notes

If you are upgrading from a version earlier than 1.1.3 you will need to perform the following manual steps after upgrading to fix the collection of network throughput metrics. These steps must be performed on any Zenoss collector server monitoring CloudStack. These steps will remove all historical performance data collected for network throughput, but that matters less because the historical data is completely wrong. If you do not perform these steps, the network data collected after upgrading will continue to be wrong.

Bulbgraph.png Note: These steps are only necessary on Zenoss versions earlier than 5.0.

su - zenoss
cd $ZENHOME/perf/Devices
find . -name cloudstack_network\*.rrd -delete


Once you've successfully added a CloudStack cloud to Zenoss you will begin to see the following metrics available for the entire cloud to root administrator users. These numbers are aggregated from all zones, pods, clusters and hosts.

  • Memory, CPU, Private Storage: Allocation
  • Public IPs: Total and Used
  • Private IPs: Total and Used
  • Memory: Total (with and without over-provisioning), Allocated and Used
  • CPU: Total (with and without over-provisioning), Allocated and Used
  • Primary Storage: Total (with and without over-provisioning), Allocated and Used
  • Secondary Storage: Total and Used
  • Network: Read and Write

The same list of metrics are available for each zone to root administrator users. The same metrics with the exception of public IPs and secondary storage are also available for each pod.

The following metrics are available aggregated to each cluster, and for each host.

  • Memory: Total, Used and Allocated
  • CPU: Total (with and without over-provisioning), Allocated, Used and Cores
  • Network: Read and Write

The following list of metrics for VMs is available to non root administrator users.

  • CPU: Cores, Total, Used and Used Percent
  • Network: Read and Write


CloudStack has both alerts and events. Once you've successfully added a CloudStack cloud to Zenoss you will automatically receive all CloudStack alerts as events in Zenoss. You will also automatically receive all CloudStack events. However, the events will go straight into your event history by default.

To avoid overloading CloudStack and Zenoss, only the last one (1) hour of events will be checked. This allows for timezone discrepancy between the Zenoss and CloudStack servers as well as some downtime without missing events. There is no real-time event collection mechanism with the CloudStack API, so alerts and events will only be polled once per minute.

Installed Items

Installing the ZenPack will add the following items to your Zenoss system.

Device Classes
  • /CloudStack
Configuration Properties
  • zCloudStackURL
  • zCloudStackAPIKey
  • zCloudStackSecretKey
Modeler Plugins
  • zenoss.CloudStack
Monitoring Templates
  • CloudStackCloud
  • CloudStackZone
  • CloudStackPod
  • CloudStackCluster
  • CloudStackHost
  • CloudStackVirtualMachine
  • CloudStackConsoleProxy
  • CloudStackFileTouch (If hypervisor type is KVM)
Event Classes
  • /Status/CloudStack
  • /Perf/CloudStack
  • /App/CloudStack


  • Hide API secret key (ZEN-21404)
  • Migration script (ZEN-21675)
  • Allow CloudStack devices to be created for domain administrator users, non-administrator users, in addition to root administrator users.
  • Fix monitoring of network throughput metrics. (ZEN-16956)
  • Fix conflict with SolarisMonitor 2.2.0.


Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.zenoss.CloudStack-*.egg
  4. Restart these services:
    $ zenoss restart

Developer Mode Installation

In order to do a development mode installation you will want to clone the existing git repository, and then use the --link flag with the zenpack command:

  1. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  2. Start by cloning the upstream repository:
    $ git clone git://github.com/zenoss/ZenPacks.zenoss.CloudStack.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.zenoss.CloudStack
  4. Finally, restart these serivices:
    $ zenoss restart


Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus