View queue, topic and subscription message counts (including scheduled)

[alexespencer]

I would like to be able to obtain the active, pending and dead-letter message counts from a queue, topic or subscription

Either via ServiceBusAdministrationClient or the receiver itself?

You used to be able to do this with the old library?

[swathipil]

@alexespencer Thanks for your question!

The active, scheduled, and dead-letter message counts are all provided by the *RuntimeProperties objects returned by the list_*_runtime_properties methods on the ServiceBusAdministrationClient.

For example, you can use the get_queue_runtime_properties method to obtain the QueueRuntimeProperties object:

import os
from azure.servicebus.management import ServiceBusAdministrationClient

CONNECTION_STR = os.environ['SERVICE_BUS_CONNECTION_STR']
QUEUE_NAME = os.environ['SERVICE_BUS_QUEUE_NAME']

servicebus_mgmt_client = ServiceBusAdministrationClient.from_connection_string(CONNECTION_STR)

# below returned object is a QueueRuntimeProperties object
queue_info = servicebus_mgmt_client.get_queue_runtime_properties(QUEUE_NAME)

# access the active, scheduled, and dead-letter message counts
print(queue_info.active_message_count)
print(queue_info.scheduled_message_count)
print(queue_info.dead_letter_message_count)

You can also find similar methods for subscription and topic here and here.

Thanks!

[ghost]

Hi @alexespencer. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text “/unresolve” to remove the “issue-addressed” label and continue the conversation.

[swathipil]

@alexespencer - You mentioned that you were able to find the active, scheduled, and dead-letter message counts in the "old library". Out of curiosity, were you referring to azure-servicebus==0.50.3 or a different version? This would be useful to know so that we can update our migration guide with this info to help others that have the same question as you. Thanks!

[alexespencer]

Yes, that is correct. I also checked through the examples you have in the git repo (like receiving / sending etc) and there isn't an example that does this. So that could help too?

…

On Thu, 19 Aug 2021, 18:53 swathipil, ***@***.***> wrote: @alexespencer <https://github.com/alexespencer> - You mentioned that you were able to find the active, scheduled, and dead-letter message counts in the "old library". Out of curiosity, were you referring to azure-servicebus==0.50.3 or a different version? This would be useful to know so that we can update our migration guide <https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/servicebus/azure-servicebus/migration_guide.md#working-with-administration-client> with this info to help others that have the same question as you. Thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#20245 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABYQQPIUD4WWNKF2BKULBDTT5VAJ7ANCNFSM5CCFQNRA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email> .

[swathipil]

Very helpful to know, thanks!

[ghost]

Hi @alexespencer, since you haven’t asked that we “/unresolve” the issue, we’ll close this out. If you believe further discussion is needed, please add a comment “/unresolve” to reopen the issue.