ZenPack:OpenStack (Tenant View)

From Zenoss Wiki
Revision as of 02:30, 18 December 2013 by Chet Luther (Talk | contribs)$7

Jump to: navigation, search

Note: This is a Core ZenPack which can be found in the Core Zenoss RPM, and is fully documented in the Zenoss Extended Monitoring Guide. If you did not install this pack when you installed Zenoss Core, it can be found in $ZENHOME/packs.

Zenoss, Inc.
ZenPack name
More Information
GitHub page/HomePage
Git sources (for cloning)

Applications Monitored: 

OpenStack (Tenant View) ZenPack

This project is a Zenoss extension (ZenPack) that allows for monitoring of OpenStack. This means that you can monitor the flavors, images and servers a user or consumer perspective.


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 ZenPack is part of Zenoss Core. Open Source users receive community support for this ZenPack via our online forums. Enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.


This ZenPack allows for monitoring of OpenStack. This means that you can monitor the flavors, images and servers from a user or consumer perspective. OpenStack API versions 1.0 and 1.1 are supported. Please watch the Monitoring OpenStack video for a quick introduction that covers most of the details below.

Bulbgraph.png Note: The video is of an early version of the ZenPack that doesn't have as many options when adding an OpenStack endpoint. See the usage notes below for help with the new fields available on the Add OpenStack dialog.

OpenStack is a global collaboration of developers and cloud computing technologists producing the ubiquitous open source cloud computing platform for public and private clouds. The project aims to deliver solutions for all types of clouds by being simple to implement, massively scalable, and feature rich. The technology consists of a series of interrelated projects delivering various components for a cloud infrastructure solution.


Once the OpenStack ZenPack is installed you can begin monitoring by going to the infrastructure screen and clicking the normal button for adding devices. You'll find a new option labeled, "Add OpenStack."

Choose that option and you'll be presented with a dialog asking for the following inputs.

  1. Username - Same username used to login to OpenStack web interface
  2. API Key - Can be found by going to "Your Account/API Access"
  3. Project ID - This can be left blank if you don't know what it is
  4. Auth URL - For Rackspace this would be https://auth.api.rackspacecloud.com/v2.0
  5. Region Name - This can be left blank if you don't know what it is

Once you click Add, Zenoss will contact the OpenStack API and discover servers, images and flavors. Once it is complete you'll find a new device in the OpenStack device class with the same name as the hostname or IP you entered into the dialog. Click into this new device to see everything that was discovered.

The following types of elements are discovered.

  • Servers
  • Images
  • Flavors

The following metrics are collected.

  • Total Servers and Servers by State
    • States: Active, Build, Rebuild, Suspended, Queue Resize, Prep Resize, Resize, Verify Resize, Password, Rescue, Reboot, Hard Reboot, Delete IP, Unknown, Other
  • Total Images and Images by State
    • States: Active, Saving, Preparing, Queued, Failed, Unknown, Other
  • Total Flavors

Status monitoring is performed on servers and images with the following mapping of state to Zenoss event severity.

Servers State to Severity Mapping
Reboot, Hard Reboot, Build, Rebuild, Rescue, Unknown == Critical
Resize == Error
Prep Resize, Delete IP == Warning
Suspended, Queue Resize, Verify Resize, Password == Info
Active == Clear
Images State to Severity Mapping
Failed, Unknown == Critical
Queued, Saving, Preparing == Info
Active == Clear

If you are also using Zenoss to monitor the guest operating system running within the server Zenoss will present the graphs for that operating system when the graphs option is chosen for the OpenStack server.


  • Add support for compute API versions 2 and 3. Still support version 1.
  • Add zOpenstackComputeApiVersion configuration property.
  • Update python-novaclient to 2.15.0.
  • Support uuid format for image identifier.


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.OpenStack-*.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.OpenStack.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.zenoss.OpenStack
  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