Queue Search

Overview

The Queue Search feature in your Togo MQ dashboard allows you to search and monitor queues across your infrastructure by topic name. This powerful tool helps you:

  • Monitor queue statistics - View message counts and sizes across all your queues
  • Search by topic patterns - Find specific queues using topic name patterns
  • Track message volumes - Monitor total messages and data sizes
  • Identify bottlenecks - Quickly locate queues with high message counts
  • Debug issues - Verify that messages are being queued correctly

The Queue Search aggregates data from all your active nodes and clusters, giving you a unified view of your entire messaging infrastructure.

Accessing Queue Search

Step 1: Navigate to Your Dashboard

  1. Log in to your Togo MQ account
  2. Select your tenant from the tenant switcher (if you have multiple)
  3. Click on "Queue Search" in the sidebar navigation

The Queue Search page will load, showing a search form where you can filter queues by topic name.

Step 2: Understanding the Interface

The Queue Search interface consists of:

  • Search Input - Enter a topic name or pattern to search
  • Search Button - Execute the search
  • Clear Button - Reset the search and clear results
  • Results Table - Displays queue statistics in a paginated table
  • Summary Statistics - Shows total messages, total size, and queue count

Search by Topic Name

Basic Search

To search for queues, simply enter a topic name in the search field:

  1. Enter a topic name - Type the topic name you want to search for

    • Example: orders
    • Example: notifications
    • Example: user-events

  2. Click "Search" - Execute the search

  3. View results - The results table will show all matching queues

Search All Queues

To view all queues for your tenant:

  1. Leave the search field empty
  2. Click "Search"
  3. All queues will be displayed in the results

{info} Searching with an empty topic name retrieves all queues associated with your tenant.

Search Results

After performing a search, you'll see:

Summary Statistics

At the top of the results:

  • Total Messages - The total number of messages across all matching queues
  • Total Size - The combined size of all messages (in bytes)
  • Total Queues - The number of queues matching your search

Results Table

The results table displays:

Column Description
Topic The queue topic name (without tenant prefix)
Messages Count Number of messages currently in the queue
Messages Size Total size of messages in the queue (bytes)

Pagination

Results are paginated to improve performance:

  • 20 results per page by default
  • Navigation controls at the bottom to move between pages
  • Page indicators showing current page and total pages

Search Patterns

The Queue Search supports flexible search patterns:

Exact Match

Search for an exact topic name:

orders

This will find queues with topics containing "orders" (e.g., orders, orders.new, user-orders).

Wildcard Search

The search automatically adds wildcards around your pattern, so:

orders

Actually searches for: *orders*

This means it will match:

  • orders
  • orders.new
  • orders.updated
  • customer-orders
  • pending-orders

Pattern Examples

Search Term Matches
orders Any topic containing "orders"
user Any topic containing "user"
notification Any topic containing "notification"
events Any topic containing "events"
(empty) All queues for your tenant

{info} Search is case-sensitive and looks for topics containing your search term.

Understanding the Data

Message Count

The Messages Count indicates:

  • How many messages are currently waiting in the queue
  • Messages that have been published but not yet consumed
  • Does not include messages that have already been delivered

High message counts may indicate:

  • ✅ Normal high-volume processing
  • ⚠️ Slow consumers not keeping up
  • ⚠️ Potential bottleneck in your system

Message Size

The Messages Size shows:

  • Total size of all messages in bytes
  • Helps you understand storage requirements
  • Useful for capacity planning

Size Conversions:

  • 1,024 bytes = 1 KB
  • 1,048,576 bytes = 1 MB
  • 1,073,741,824 bytes = 1 GB

Aggregation

The Queue Search aggregates data from all your active nodes and clusters:

  • If you have multiple clusters, results are combined
  • Duplicate topics from different nodes are merged
  • Counts and sizes are summed for complete totals

This gives you a unified, cluster-wide view of your messaging infrastructure.

Use Cases

1. Monitor Queue Health

Regularly check queue statistics to ensure your system is healthy:

Search: (empty - show all queues)

Look for:

  • ✅ Low message counts (consumers keeping up)
  • ⚠️ Growing message counts (potential issues)
  • ⚠️ Unusually large message sizes

2. Debug Specific Topics

When debugging an issue with a specific topic:

Search: orders

Check:

  • Are messages being queued?
  • How many messages are waiting?
  • Is the count growing or stable?

3. Identify Bottlenecks

Find queues with the highest message counts:

Search: (empty - show all queues)
Sort by: Messages Count (descending)

Investigate queues with high counts - they may need:

  • More consumers
  • Performance optimization
  • Scaling adjustments

4. Capacity Planning

Monitor total message sizes across all queues:

Search: (empty - show all queues)

Use the Total Size metric to:

  • Plan storage requirements
  • Forecast infrastructure needs
  • Set up alerts for high usage

5. Verify Message Publishing

After publishing messages, verify they were queued:

Search: your-topic-name

Confirm:

  • ✅ Queue appears in results
  • ✅ Messages count increased
  • ✅ Size reflects your message payloads

Best Practices

Regular Monitoring

  • Check daily - Monitor queue health regularly
  • Set baselines - Know what's normal for your application
  • Track trends - Watch for growing message counts

Alert Thresholds

Consider setting up alerts when:

  • Message counts exceed expected levels
  • Total queue sizes grow too large
  • Critical queues show unusual patterns

Performance Tips

  • Use specific searches - Narrow down to relevant topics
  • Empty search for overview - Get a complete picture regularly
  • Page through results - Don't overwhelm yourself with data

Troubleshooting

No Results Found

If your search returns no results:

  1. Check the topic name - Verify spelling and format
  2. Try a broader search - Use fewer characters
  3. Search all queues - Leave search empty to see everything
  4. Verify publishing - Ensure messages are being published

Unexpected Results

If results don't match your expectations:

  1. Remember wildcards - Search term has wildcards added automatically
  2. Check tenant - Ensure you're in the correct tenant context
  3. Wait for synchronization - Data may take moments to update
  4. Verify node status - Check that your nodes are active

Large Message Counts

If you see very large message counts:

  1. Check consumers - Ensure subscribers are running
  2. Review patterns - Verify subscription patterns are correct
  3. Check for errors - Look for consumer errors in logs
  4. Scale if needed - Add more consumers or optimize processing

Related Resources

{success} The Queue Search feature provides real-time visibility into your messaging infrastructure. Use it regularly to monitor queue health and troubleshoot issues!