Difference between revisions of "ZenPack:JMX Notification Listener"

From Zenoss Wiki
Jump to: navigation, search
Line 9: Line 9:
|Release date=2013/02/03
|Release date=2013/02/03
|Summary=Initial release.
|Summary=Initial release.

Revision as of 17:20, 4 February 2013

Chet Luther
Current Maintainer(s)
Chet Luther
Zenoss, Inc.
GNU General Public License, Version 2, or later
ZenPack name
More Information
GitHub page/HomePage
Git sources (for cloning)

Applications Monitored: 

JMX Notification Listener ZenPack

Capture JMX notifications as Zenoss events.


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 0.9.0- Download
Summary of changes: Initial release.
Released on 2013/02/03
Compatible with Zenoss Core 2.5.x, Zenoss Core 3.1.x, Zenoss Core 3.2.x, Zenoss Core 4.2.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x


This ZenPack allows JMX notifications to be captured as Zenoss events.

See ZenPacks.zenoss.ZenJMX for a ZenPack that allows polling of metrics from MBean attributes and operations.


To collect JMX notifications you must edit $ZENHOME/etc/zenjmxnotificationlistener.conf. This file must be used to specify which JMX agents to connect to, and what notifications to collect. After modifying this file you must run ``zenjmxnotificationlistener restart`` for the changes to be affected.

Upon installing the ZenPack a default ``zenjmxnotificationlistener.conf`` will be created with the following contents.

# Generic configuration

# Zenoss XML-RPC connection properties
# xmlRpcUrl is the zenhub url

# Each comma-delimited token in serverList must have at least a
# server.TOKEN.url= entry specified below.

# Properties where <TOKEN> matches one of the entries in the serverList property
# server.TOKEN.zenossDevice is REQUIRED
# server.TOKEN.url is REQUIRED
# server.TOKEN.scope is OPTIONAL and defaults to *:* or all notification mbeans
# server.TOKEN.username is OPTIONAL and defaults to null
# server.TOKEN.password is OPTIONAL and defaults to null
# server.TOKEN.attributeFilters is OPTIONAL, filter for attributes of interest

# example Definitions for a local Tomcat instance


The scope and attributeFilters properties are optional, and can be used to restrict the notifications captured from a given server. MBeanServerNotification type notifications are ignored by default as they are noisy and unlikely to be useful.


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