ZenPack:ZopeMonitor

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search
Author(s)
Alan Milligan
Current Maintainer(s)
Alan Milligan
Organization
Last Bastion Network
License
GNU General Public License, Version 2, or later
ZenPack name
ZenPacks.lbn.ZopeMonitor


Applications Monitored: 



ZopeMonitor ZenPack

Zope Application Server Montoring

Warning

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.

Support

This ZenPack is developed by the Zenoss user community and supported via our online forums. Zenoss, Inc. does not provide direct support for this ZenPack.

Version 1.0
Compatible with Zenoss Core 2.5.x

Background

ZopeMonitor provides a method for pulling performance metrics from a Zope Application Server directly into Zenoss. It is necessary to first install the munin.zope eggs from pypi.python.org or our own repo at http://linux.last-bastion.net/LBN/up2date/monitor, and to have wget installed on this server.

The monitor works by utilising ZenCommand to run wget on the local system - you do not need to make zope ports available through your firewall.

The munin plugins do require a user with 'View Management Screens' access at the root however. This is configured using the zZopeURI zProperty of the device. This parameter uses Extended HTTP Authentication to specify user credentials, host and port. Note that the host is the hostname on the remote instance and should probably remain 'localhost' unless you've explicitly bound your Zope to a NIC.

Note that the munin plugins expect to be installed on a Unix-like operating system with a /proc filesystem.

The following metrics will be collected and graphed for the Zope Server.

  • Threads
    • Free threads
    • Total threads
  • Cache
    • Total objects
    • Total objects in memory
    • Targe number
  • ZODB Activity
    • Total connections
    • Total load count
    • Total store count
  • Memory Utilisation
    • VmHWM - peak resident set size ("high water mark")
    • VmExe - size of text segments
    • VmStk - size of stack segments
    • VmPeak - peak virtual memory size
    • VmData - size of data segments
    • VmLck - locked memory size
    • VmPTE - page table entries size
    • VmLib - shared library code size
    • VmRSS - resident set size

Once your Zope Server has the munin plugins installed, you can add Zope monitoring to the device within Zenoss by simply binding the ZopeMonitor template to the device.

  1. Navigate to the device in the Zenoss web interface.
  2. Click the device menu, choose More then Templates.
  3. Click the templates menu, choose Bind Templates.
  4. Ctrl-click the ZopeMonitor template from /Devices/Server to choose it.
  5. Click OK.

You will now be collecting the Zope Server metrics from this device.

Installation

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.lbn.ZopeMonitor-*.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/path/to/repo
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.lbn.ZopeMonitor
  4. Finally, restart these serivices:
    $ zenoss restart

Discuss

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

blog comments powered by Disqus