ZenPack:Microsoft Message Queueing (MSMQ)

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
ZenPack name
More Information
GitHub page/HomePage
Git sources (for cloning)

Applications Monitored: 

Microsoft Message Queueing (MSMQ) ZenPack

Monitoring for Microsoft Message Queueing (MSMQ).


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.3.0- Download
Released on 2014/06/13
Requires Microsoft Windows ZenPack
Compatible with Zenoss Core 4.2.x, Zenoss Core 5.0.x, Zenoss Core 5.1.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x, Zenoss Resource Manager 5.1.x


The ZenPacks.zenoss.Microsoft.MSMQ ZenPack uses WinRM to automatically discover Microsoft Message Queue (MSMQ) queues, and monitor the number of messages queued in each.

The following description of Microsoft Message Queue (MSMQ) can be found on Microsoft's MSMQ product page.

"Microsoft Message Queue (MSMQ) technology enables applications running at different times to communicate across heterogeneous networks and systems that may be temporarily offline. MSMQ provides guaranteed message delivery, efficient routing, security, and priority-based messaging. It can be used to implement solutions for both asynchronous and synchronous messaging scenarios."


To monitor MSMQ queues, set up proper credentials so that Zenoss platform can remotely monitor the target Windows servers.

This ZenPack supports two approaches to enable MSMQ queue monitoring, as detailed in the next sections.

Automatically Monitor Queues on All Servers

The easiest way to configure Zenoss platform to monitor your queues is to enable queue discovery for the entire /Server/Microsoft/Windows device class. Within 12 hours Zenoss platform will have automatically discovered all of the queues available to be monitored and begun monitoring how many messages are in each queue and creating threshold events if they exceed 10,000 messages.

Perform the following steps to enable queue discovery for all Windows servers.

  1. Navigate to the /Server/Microsoft/Windows device class.
  1. Click Details.
  1. Select Modeler Plugins from the left panel.
  1. Click Add Fields.
  1. Drag zenoss.winrm.MSMQQueueMap from the available fields to the list of plugins.
  1. Click Save.
  1. Wait about 12 hours for all Windows servers to be remodeled.

Monitor Queues on Specific Servers

If you do not want Zenoss platform automatically monitoring queues on all of your Windows servers and would rather point it to specific servers you can do so by performing the following steps on each server you're interested in.

  1. Navigate to the device.
  1. Select Modeler Plugins from the left panel.
  1. Click Add Fields.
  1. Drag zenoss.winrm.MSMQQueueMap from the available fields to the list of plugins.
  1. Click Save.
  1. Select Model Device from the Action menu.

Fine-Tuning Queue Monitoring

By default Zenoss platform will automatically monitor all queues on a server that is running the MSMQ services. Each queue will also have a default 10,000 maximum threshold applied to it. This means that an event will be created when the number of messages in a single queue exceeds 10,000.


By default queues with names beginning with tcp will not be discovered. You can change this behavior with the zMSMQIgnoreQueues property. This property is a regular expression and any queues that match it will not be discovered.

You can change the maximum messages threshold on a per-queue basis by changing the Queues Messages Threshold property. Leaving this value blank will have the result of no threshold being applied.


Type Name
Modeler zenmodeler
Performance Collector zenpython


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.Microsoft.MSMQ-*.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 https://github.com/zenoss/ZenPacks.zenoss.Microsoft.MSMQ.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.zenoss.Microsoft.MSMQ
  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