Skip to content

Commit 3a38291

Browse files
User indicators documentation (#7221)
Co-authored-by: Andreas Öhlund <[email protected]>
1 parent 99e734c commit 3a38291

File tree

3 files changed

+31
-1
lines changed

3 files changed

+31
-1
lines changed

nservicebus/transactional-session/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ It's recommended to not mix the processing of control messages with business mes
8383
- More accurate metrics: Metrics like critical time and queue length will accurately represent the performance of the control message processing and not be skewed by business messages
8484
- Simplified management: Knowing that the endpoint only processes control messages makes it possible to always retry all failed messages related to the endpoint via tools like ServicePulse
8585

86+
When configuring endpoints for usage measurement in ServicePulse, mark dedicated transactional session processor endpoints with the appropriate [endpoint type indicator](/servicepulse/usage.md#setting-an-endpoint-type-endpoint-type-indicators).
87+
8688
partial: remote-processor
8789

8890
## Transaction consistency
-85.6 KB
Loading

servicepulse/usage.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,38 @@ This option will not be displayed for non-broker transports (e.g. MSMQ and Azure
5757

5858
The usage summary may contain detected queues that should not be counted as part of a license with Particular Software.
5959

60-
Once a report is submitted to Particular, it is reviewed and any system queues that should not be counted for licensing purposes are removed.
60+
Once a report is submitted to Particular, it is reviewed, and any system queues that should not be counted for licensing purposes are removed.
6161

6262
In addition, the detected endpoints and broker queues screens provide an option to set the endpoint type, which specifies a reason as to why a queue should not be included in the licensing calculations. Any changes made to the endpoint type are automatically saved.
6363

64+
### Endpoint type indicators
65+
66+
The following endpoint type indicators are available to help categorize endpoints appropriately:
67+
68+
#### NServiceBus Endpoint
69+
70+
Known NServiceBus [endpoint](/nservicebus/endpoints/). These endpoints are included in licensing calculations as they represent active NServiceBus endpoints processing business messages.
71+
72+
#### No longer in use
73+
74+
NServiceBus endpoint that is no longer in use, usually this would have zero throughput. These endpoints are not included in licensing calculations since they are inactive.
75+
76+
#### Transactional Session Processor Endpoint
77+
78+
An [endpoint that is only processing transactional session control messages](/nservicebus/transactional-session/#design-considerations). These are [specialized endpoints](/nservicebus/transactional-session/#remote-processor) dedicated to handling the coordination of transactional sessions, and it is excluded during licensing calculations.
79+
80+
#### Send-Only Endpoint
81+
82+
An endpoint that [only sends](/nservicebus/hosting/#self-hosting-send-only-hosting) messages and does not process any messages. These endpoints have different licensing considerations since they don't process incoming messages.
83+
84+
#### Planned to be decommissioned
85+
86+
If the endpoint is planned to no longer be used in the next 30 days. These endpoints may be excluded from licensing calculations as they represent temporary infrastructure.
87+
88+
#### Not an NServiceBus Endpoint
89+
90+
Not an NServiceBus endpoint. These are broker queues or other messaging infrastructure that should not be included in NServiceBus licensing calculations.
91+
6492
### Bulk endpoint updates
6593

6694
The filter option can be used for bulk updating of endpoints or queues matching a certain naming pattern.

0 commit comments

Comments
 (0)