There are two methods available for measuring usage of an NServiceBus system:
- Using ServicePulse (recommended)
- Standalone Endpoint Throughput tool
Both methods will generate a usage report containing NServiceBus endpoint count and throughput summary. The report is saved as a file onto the local machine, which needs to be sent to Particular upon request, usually at license renewal time.
Benefits of using ServicePulse to measure usage
The recommended method for measuring usage in an NServiceBus system is via ServicePulse, which offers the following advantages:
- ability to view system usage at any time
- ability to specify if a detected queue should not be included in license pricing
- incorporated into the existing Particular Platform - the report can be generated directly from ServicePulse
- improved endpoint detection for endpoints that have Monitoring or Audit enabled
- once setup, there's no more work required, just a button press once a year to generate the usage report
This method requires ServicePulse version 1.40 or later, and ServiceControl version 5.4 or later. Additionally, if using RabbitMQ broker, version 3.10.0 or higher is required.
To learn more about this method, read the ServicePulse Usage documentation.
While customers are not required to use ServicePulse at this time, it will become a requirement for all active projects in the future.
Standalone Endpoint Throughput tool
Customers who are not able to use ServicePulse can use the Endpoint Throughput tool to measure their system usage.
This is a standalone tool that is run on demand, and can typically be installed on a user's workstation.
To learn more about this method, read the Endpoint Throughput tool documentation.
Requirements
If measuring usage for NServiceBus endpoints using MSMQ or Azure Storage Queues transport, then Auditing or Monitoring needs to be enabled on all NServiceBus endpoints.