The Particular throughput tool can be installed locally and run against a production system to discover the throughput of each endpoint in a system over a period of time.
This article details how to collect endpoint and throughput data when the system uses the RabbitMQ transport. Refer to the throughput counter main page for information how to install/uninstall the tool or for other data collection options.
Running the tool
To collect data from RabbitMQ, the management plugin must be enabled on the RabbitMQ broker. The tool will also require a login that can access the management UI.
Execute the tool, providing the RabbitMQ management URL, as in this example where the RabbitMQ broker is running on localhost.
If the tool was installed as a .NET tool:
throughput-counter rabbitmq [options] --apiUrl http://localhost:15672
Or, if using the self-contained executable:
Particular.EndpointThroughputCounter.exe rabbitmq [options] --apiUrl http://localhost:15672
The tool will prompt for the username and password to access the RabbitMQ management interface. After that, it will take its initial reading, then sleep for 24 hours before taking its final reading and generating a report.
Options
| Option | Description |
|---|---|
--apiUrl | Required – The URL for the RabbitMQ management site. Generally this will be http:/ |
--queueNameMasks | Masks sensitive information in the generated report. See masking private data. |
--customerName | Sets the customer name. If not provided, the tool will prompt for the information. Example: --customerName "Particular Software" |
--unattended | Will not prompt for user input, so that the tool can be used from environments such as a continuous integration system. |
--skipVersionCheck | Will not perform the check, for use in environments when outgoing network access creates alerts. |
What the tool does
After performing an interactive login to the RabbitMQ Management API, the tool will:
- Query
/to get basic information about the system, ensure that the current version of RabbitMQ is compatible with the tool, and that the necessary plugins are installed to be able to get queue throughput details.api/ overview - Query
/to discover queue names and to get the message stats for each queue. If more than 500 queues are present, the additional pages of data will be requested as well.api/ queues?page=1&page_size=500&name=&use_regex=false&pagination=true - The queries to
/will be repeated every 5 minutes over the 24-hour tool runtime. This way, the tool can continue counting if a restart of a RabbitMQ server instance causes the message stats to reset.api/ queues