Microsoft Message Queuing

Plugin: windows.plugin Module: PerflibMSMQ

Overview

This collector monitors Microsoft Message Queuing (MSMQ) queues on Windows.

It queries the MSMQ Queue object from Perflib to gather per-queue message and byte counts, including journal queue statistics.

This collector is only supported on the following platforms:

• windows

This collector supports collecting metrics from multiple instances of this integration.

Default Behavior

Auto-Detection

The collector detects queues automatically when Perflib reports them; newly created or idle queues may not appear until they become active, such as after a message is sent. It charts up to 100 matching queues individually by default and aggregates unmatched or over-limit queues into an Other (aggregated) series. Configure the selector and cap in [plugin:windows:PerflibMSMQ].

Limits

By default, at most 100 queues are charted individually. Remaining queues are aggregated; setting the individual queue limit to 0 aggregates all queues.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

Prerequisites

Microsoft Message Queuing (MSMQ) installed

MSMQ must be installed and running on the Windows host. The collector will return no data if the MSMQ Queue performance object is not present in the registry.

Configuration

Options

Option	Description	Default	Required
update every	Data collection frequency.	1	no
queues to chart individually	Case-insensitive simple patterns separated by commas or pipes. Windows queue paths can be pasted verbatim; escape a comma or pipe with a backslash to match that character literally. Selectors match raw Perflib instance names; the queue chart label is sanitized for display. Matching queues are chosen in case-insensitive alphabetical order before applying the individual chart limit. An empty selector or a negative-only selector, such as !*temp*, selects no queues for individual charts, so all queues are aggregated. Add a positive pattern, for example !*temp*,*, to select every queue except those matching *temp*.	*	no
max individually charted queues	Maximum number of matching queues to chart individually. Other queues are summed into the Other (aggregated) series; 0 aggregates all queues.	100	no

via File

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:windows:PerflibMSMQ] section within that file.

The file format is a modified INI syntax. The general structure is:

[section1]
    option1 = some value
    option2 = some other value

[section2]
    option3 = some third value

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf

Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per queue

These metrics refer to one MSMQ queue or the aggregate of queues selected for the Other series.

Labels:

Label	Description
queue	The queue name, or Other (aggregated) for the sum of queues not charted individually.

Metrics:

Metric	Description	Dimensions	Unit
msmq.queue_messages	MSMQ messages in queue	queued	messages
msmq.queue_bytes	MSMQ bytes in queue	queued	bytes
msmq.queue_journal_messages	MSMQ messages in journal queue	queued	messages
msmq.queue_journal_bytes	MSMQ bytes in journal queue	queued	bytes