Editorial around usage reporting in ServicePulse - #8515
Open
helenktsai wants to merge 2 commits into
Open
helenktsai wants to merge 2 commits into
helenktsai wants to merge 2 commits into
Conversation
bording
approved these changes
Sep 28, 2026
helenktsai
commented
Sep 28, 2026
helenktsai
commented
Oct 1, 2026
helenktsai
commented
Oct 1, 2026
helenktsai
commented
Oct 1, 2026
soujay
reviewed
Oct 1, 2026
soujay
reviewed
Oct 1, 2026
soujay
reviewed
Oct 1, 2026
soujay
approved these changes
Oct 1, 2026
tamararivera
approved these changes
Oct 2, 2026
Co-Authored-By: Helen T <35390871+helenktsai@users.noreply.github.com> Co-Authored-By: Jayanthi <jayanthi.sourirajan@particular.net>
helenktsai
force-pushed
the
usage-config
branch
from
October 2, 2026 23:34
1084510 to
da49578
Compare
tamararivera
reviewed
Oct 3, 2026
|
|
||
| A usage report is a file generated by ServicePulse that shows messaging throughput of a system based on identified NServiceBus endpoints and the throughput of their corresponding queues. To enable this functionality in ServicePulse, [usage reporting setup](/servicepulse/usage-reporting-setup.md) must be completed first. Once configured, no ongoing maintenance is needed, and the Usage page will display throughput for each queue detected. | ||
|
|
||
| After at least 24 hours of data is collected, the report can be downloaded from the Usage page. This is needed when licensing the Particular Platform. Particular Software does not automatically have access to this report; it is typically requested at license renewal time and must be downloaded and sent manually. Before submitting the report, [sensitive data can be masked](usage-reporting-setup.md#report-masks) and queues that do not map to NServiceBus endpoints (and therefore, do not count toward licensing) can be marked as such. |
Member
There was a problem hiding this comment.
Suggestion: Removing some information that is also on the Downloading the report section
Suggested change
| After at least 24 hours of data is collected, the report can be downloaded from the Usage page. This is needed when licensing the Particular Platform. Particular Software does not automatically have access to this report; it is typically requested at license renewal time and must be downloaded and sent manually. Before submitting the report, [sensitive data can be masked](usage-reporting-setup.md#report-masks) and queues that do not map to NServiceBus endpoints (and therefore, do not count toward licensing) can be marked as such. | |
| This report is needed when licensing the Particular Platform and must be downloaded and sent manually. Before submitting the report, [sensitive data can be masked](usage-reporting-setup.md#report-masks) and queues that do not map to NServiceBus endpoints (and therefore, do not count toward licensing) can be marked as such. |
|
|
||
| ### Detected endpoint queues | ||
|
|
||
| All detected endpoint queues have a clear connection to an NServiceBus endpoint which counts toward licensing. However, these can be marked to indicate if they correspond to a [type of endpoint that should not count toward licensing](#endpoint-type-indicators). |
Member
There was a problem hiding this comment.
Suggestion: This feels a bit disjointed
Suggested change
| All detected endpoint queues have a clear connection to an NServiceBus endpoint which counts toward licensing. However, these can be marked to indicate if they correspond to a [type of endpoint that should not count toward licensing](#endpoint-type-indicators). | |
| This list correspond to all endpoint queues that have a clear connection to an NServiceBus endpoint which counts toward licensing. However, these can be marked to indicate if they correspond to a [type of endpoint that should not count toward licensing](#endpoint-type-indicators). |
|
|
||
| ## Downloading a usage report | ||
|
|
||
| Click `Download Report` from ServicePulse to generate a usage report JSON file with the detected [endpoint queues](#viewing-usage-data-in-servicepulse-detected-endpoint-queues) and [broker queues](#viewing-usage-data-in-servicepulse-detected-broker-queues). The report includes the [endpoint type](#endpoint-type-indicators) selections made on screen, and any specified [words to mask](usage-reporting-setup.md#report-masks) will be obfuscated. |
Member
There was a problem hiding this comment.
Suggestion: Adding more words
Suggested change
| Click `Download Report` from ServicePulse to generate a usage report JSON file with the detected [endpoint queues](#viewing-usage-data-in-servicepulse-detected-endpoint-queues) and [broker queues](#viewing-usage-data-in-servicepulse-detected-broker-queues). The report includes the [endpoint type](#endpoint-type-indicators) selections made on screen, and any specified [words to mask](usage-reporting-setup.md#report-masks) will be obfuscated. | |
| Click `Download Report` to generate a usage report as a JSON file. This report contains the queues from both the [detected endpoint queues](#viewing-usage-data-in-servicepulse-detected-endpoint-queues) and [detected broker queues](#viewing-usage-data-in-servicepulse-detected-broker-queues) tabs. The report also includes the [endpoint type](#endpoint-type-indicators) selections made on screen, and any specified [words to mask](usage-reporting-setup.md#report-masks) will be obfuscated. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.