Get MSMQ Queue Counts in C#
page 1 of 1
Published: 08 Nov 2011
This article demonstrates a simple way to quickly retrieve the length of MSMQ queues from an ASP.NET MVC application using C#.
by Steven Smith
Average Rating: This article has not yet been rated.
Views (Total / Last 10 Days): 65070/ 45

I’m working with NServiceBus and MSMQ for one of my projects, and I wanted to be able to show a simple dashboard with the numbers of messages in each of the relevant queues for the application.  Unfortunately, there isn’t a simple ".Count()” method or property in the built-in System.Messaging namespace for MSMQ queues, so if you want to get the message count there are a few ways to go about it.  You can use COM interop, but just as this blog’s author, I didn’t want to take that dependency.  In the end, the result I came up with is from that post’s comments, which is to specify a MessagePropertyFilter on the Queue, and then when you call GetAllMessages() it will use this filter and will avoid pulling back the full message body contents as well as avoid removing the messages from the queue.  Here’s my simple function for fetching the count for a given queue:

protected int GetMessageCount(MessageQueue q)
    var filter = new MessagePropertyFilter()
                         AdministrationQueue = false,
                         ArrivedTime = false,
                         CorrelationId = false,
                         Priority = false,
                         ResponseQueue = false,
                         SentTime = false,
                         Body = false,
                         Label = false,
                         Id = false
    q.MessageReadPropertyFilter = filter;
    return q.GetAllMessages().Length;

I created a simple MVC Controller to display the counts, with an action like this one:

public ActionResult Index()
    string machine = Environment.MachineName;
    string[] queues = new []{machine + @"\private$\queue1", 
        machine + @"\private$\queue2", 
        machine + @"\private$\queue3"};
    Dictionary<string, int> qcounts = new Dictionary<string, int>();
    foreach (var queue in queues)
        var messageQueue = new MessageQueue(queue);
        qcounts.Add(queue, GetMessageCount(messageQueue));
    return View(qcounts);

And just to make things complete, here’s the View:

@model System.Collections.Generic.Dictionary<string,int>
    ViewBag.Title = "Queue Counts";
<h2>Queue Counts</h2>
            <td>Message Count</td>
    @foreach (KeyValuePair<string, int> keyValuePair in Model)
With that, you can quickly view the counts of the queues on the local machine.  I’m assuming this will work for remote queues just the same, provided you have the necessary security credentials for the appdomain your web app is running under, but I admit I’ve not yet tried that.

User Comments

Title: friend   
Name: friend
Date: 2012-09-17 8:10:54 AM
Title: jhjk   
Name: hjkh
Date: 2012-07-06 2:02:16 AM
Title: Apnabihar   
Name: vinay
Date: 2012-03-21 12:53:11 AM
Title: Mr   
Name: Iulian Margarintescu
Date: 2011-11-09 4:10:37 AM
Have you performed any performance testing of this method for the cases when the queue has lots ( >10k ) messages?

Community Advice: ASP | SQL | XML | Regular Expressions | Windows

©Copyright 1998-2024  |  Page Processed at 2024-06-22 9:06:39 PM  AspAlliance Recent Articles RSS Feed
About ASPAlliance | Newsgroups | Advertise | Authors | Email Lists | Feedback | Link To Us | Privacy | Search