ZenPack:OpenStack (Provider View)

From Zenoss Wiki
Revision as of 22:43, 9 October 2014 by Jwilmes (Talk | contribs)$7

(diff) ← Older revision | Approved revision (diff) | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Zenoss, Inc.
GNU General Public License, Version 2, or later
ZenPack name
More Information
GitHub page/HomePage
Git sources (for cloning)

Applications Monitored: 

OpenStack (Provider View) ZenPack

This ZenPack allows for monitoring of OpenStack from a service provider perspective. This means that in addition to the user-oriented components supported in the regular OpenStack ZenPack (instances, flavors, images), the underlying OpenStack servers and software are monitored.


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 2.0.0- Download
Summary of changes: Initial Version
Released on 2014/10/09
Requires PythonCollector ZenPack,OpenStack Cloud Monitor ZenPack
Compatible with Zenoss Core 4.2.x, Zenoss Resource Manager 4.2.x
Enhances OpenStack Cloud Monitor


This ZenPack allows for monitoring of OpenStack from a service provider perspective. This means that in addition to the user-oriented components supported in the regular OpenStack ZenPack (instances, flavors, images), the underlying OpenStack servers and software are monitored.


  • OpenStack (Icehouse or newer)
  • Ceilometer
    • A zenoss-specific ceilometer plugin must be installed on your ceilometer nodes (see below)
    • If you do not have ceilometer installed and configured properly, some graphs will be black, and Zenoss will not detect changes (such as new instances or instance state changes) until a full model operation is performed.
  • SSH credentials to the linux devices in your openstack environment
    • Configure the zCommandUsername/zCommandPassword properties on the /Devices/Server/SSH/Linux/NovaHost device class.
    • If your linux devices are already managed under Zenoss, move them into /Devices/Server/SSH/Linux/NovaHost
  • Administrative credentials for your OpenStack environment
    • Username, password, keystone URL, Region

Basic Usage

Once the OpenStack ZenPack is installed and 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 Endpoint (Infrastructure)."

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

  1. Device To Create - name to use for this device in zenoss. Should not be an actual hostname, since that name will be used when the host is registered as a linux device.
  2. Auth URL - A keystone URL, such as http://<hostname>:5000/v2.0/
  3. Username, Password / API Key, Project/Tenant ID - *Administrative* credentials to your zenoss instance.
  4. Region Name - choose the correct region from the dropdown. You may only choose one, so each region you wish to manage must be registered as a separate endpoint in zenoss.
  5. Ceilometer URL - Will auto-populate based on the other selections.

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.

  • Tenants
  • Instances (Servers)
  • vNICs
  • Images
  • Flavors
  • Nova API Endpoints
  • Regions
  • Availability Zones
  • Hosts
  • Nova Services (processes supporting nova servers)
  • Hypervisors

The following metrics are collected.

  • Images

Total Images Images by State

  • Flavors

Total Flavors

  • Instance Metrics

Total Instances Instances by State CPU Utilization (percent)

   Disk Requests (requests/sec)
   Disk IO Rate (bytes/sec)
  • Vnic Metrics
   Network Packet Rate (packets/sec)
   Network Throughput (bytes/sec)
  • Host Metrics (Zenoss Linux OS monitoring)

Load Average CPU Utilization Free Memory Free Swap IO

  • Nova Service Metrics (Zenoss Process monitoring)

CPU Utilization Memory Utilization Process Counts per Service

All metrics collected by OpenStack Ceilometer may be collected and graphed in Zenoss, and all events processed through ceilometer are exposed via the Zenoss Event Console.

Ceilometer Enablement

Although you may add an openstack device to zenoss, as shown above, event and performance data will not be collected until the following steps are performed.

Zenoss Configuration Steps

On your zenoss host, you must run the following command as the zenoss user:


It will create a new user in rabbitmq and set up its permissions. It will print out the proper values to use for amqp_hostname, amqp_port, amqp_userid, amqp_password, and amqp_virtualhost during ceilometer configuration (see below)

OpenStack Ceilometer Configuration Steps

Zenoss relies upon a ceilometer dispatcher plugin to ship raw event and metering data from ceilometer to Zenoss for storage in the Zenoss event and performance databases. This integration is done by publishing messages to Zenoss's RabbitMQ server.

This dispatcher should be installed on all nodes running any ceilometer, but particularly those running ceilometer-collector or ceilometer-agent-notification.

To install it, perform the following steps on each of these openstack nodes (NOT on the zenoss collector):

  sudo pip -q install --force-reinstall https://github.com/zenoss/ceilometer_zenoss/archive/master.zip
  sudo cp /usr/lib/python2.6/site-packages/ceilometer_zenoss/event_definitions.yaml /etc/ceilometer/

Edit /etc/ceilometer/ceilometer.conf, and add the following lines to the appropriate sections:


Also add the [dispatcher_zenoss] section reported by openstack_amqp_config above.

Optional Steps

VM State Changes

By default, instance state changes will be captured by Zenoss when certain events occur, for example, when an instance is shut down, the state change to SHUTDOWN will be reflected in Zenoss.

However, certain state changes that don't correspond to another defined event may not be picked up until the next time zenoss models the environment.

If you would like to reduce the likelihood of this occurring, you can configure OpenStack Nova to send an event (through ceilometer) to zenoss whenever any VM state change occurs by adding the following to nova.conf:


Note that this will cause increased event load, both on OpenStack and Zenoss, and additional processing within the event transforms in Zenoss to keep the model consistent. Since most instance changes will still be caught without this option enabled, it is recommended to leave this disabled if your OpenStack environment is very large.

Increasing Polling Interval

Zenoss will process performance datapoints from ceilometer every 5 minutes, but by default, ceilometer will only produce one datapoint every 10 minutes. This can be adjusted by modifying the "interval: 600" line in your pipeline.yaml file (typically /etc/ceilomster/pipeline.yaml) to 300 seconds.

Zenoss Analytics

This ZenPack provides additional support for Zenoss Analytics. Perform the following steps to install extra reporting resources into Zenoss Analytics after installing the ZenPack.

  1. Copy analytics-bundle.zip from $ZENHOME/ZenPacks/ZenPacks.zenoss.OpenStackInfrastructure*/ZenPacks/zenoss/OpenStackInfrastructure/analytics/ on your Zenoss server.
  2. Navigate to Zenoss Analytics in your browser.
  3. Login as superuser.
  4. Remove any existing OpenStackInfrastructure ZenPack folder.
    1. Choose Repository from the View menu at the top of the page.
    2. Expand Public in the list of folders.
    3. Right-click on OpenStackInfrastructure ZenPack folder and choose Delete.
    4. Confirm deletion by clicking OK.
  5. Add the new OpenStackInfrastructure ZenPack folder.
    1. Choose Server Settings from the Manage' menu at the top of the page.
    2. Choose Import in the left page.
    3. Remove checks from all check boxes.
    4. Click Choose File to import a data file.
    5. Choose the analytics-bundle.zip file copied from your Zenoss server.
    6. Click Import.

You can now navigate back to the OpenStackInfrastructure ZenPack folder in the repository to see the following resources added by the bundle.

  • OpenStackInfrastructure Domain
Ad Hoc Views
  • OpenStack Instance List

Domains can be used to create ad hoc views using the following steps.

  1. Choose Ad Hoc View from the Create menu.
  2. Click Domains at the top of the data chooser dialog.
  3. Expand Public then OpenStackInfrastructure ZenPack.
  4. Choose the OpenStackInfrastructure Domain domain

Known Issues

  1. ZEN-14805: Ceilometer AMQP Heartbeat monitoring expects ceilometer-collector and ceilometer-agent-notification to run on a single host
    1. Most commonly, these processes would run on a single controller node, so this will not impact most users. No workaround available.
  2. ZEN-14585: The same endpoint can not be monitored both as user and an infrastructure endpoints.
    1. Workaround: If you have been previously monitoring the endpoint as a User endpoint, delete the device before you re-add it as an Infrastructure endpoint.
  3. ZEN-14491: A stacktrace may occur during the initial modeling of the device
    1. The trace will contain the error "ValueError: expected txn status 'Active' or 'Doomed', but it's 'Committed'"
    2. Workaround: Disregard the error. You may also manually model the device to confirm that no further errors are reported.


  • Initial Release


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