Skip to content

Commit

Permalink
Some changes based on peer reviewing
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsimons committed May 24, 2024
1 parent 1dafa6a commit 447a72d
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 37 deletions.
33 changes: 17 additions & 16 deletions menu/menu.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -764,23 +764,24 @@
- Url: nservicebus/usage
Title: Measuring system usage
- Url: servicepulse/usage
Title: Usage via ServiceControl and ServicePulse
Title: System usage via ServicePulse
- Url: nservicebus/throughput-tool
Title: Usage via throughput tool
- Url: nservicebus/throughput-tool/azure-service-bus
Title: Throughput tool - using Azure Service Bus
- Url: nservicebus/throughput-tool/amazon-sqs
Title: Throughput tool - using Amazon SQS
- Url: nservicebus/throughput-tool/rabbitmq
Title: Throughput tool - using RabbitMQ
- Url: nservicebus/throughput-tool/sql-transport
Title: Throughput tool - using SQL Transport
- Url: nservicebus/throughput-tool/service-control
Title: Throughput tool - using ServiceControl
- Url: nservicebus/throughput-tool/determine-transport
Title: Throughput tool - determining message transport
- Url: nservicebus/throughput-tool/faq
Title: Throughput tool FAQ
Title: System usage via Throughput Endpoint tool
Articles:
- Url: nservicebus/throughput-tool/azure-service-bus
Title: using Azure Service Bus
- Url: nservicebus/throughput-tool/amazon-sqs
Title: using Amazon SQS
- Url: nservicebus/throughput-tool/rabbitmq
Title: using RabbitMQ
- Url: nservicebus/throughput-tool/sql-transport
Title: using SQL Transport
- Url: nservicebus/throughput-tool/service-control
Title: using ServiceControl
- Url: nservicebus/throughput-tool/determine-transport
Title: Determining message transport
- Url: nservicebus/throughput-tool/faq
Title: FAQ
- Title: Troubleshooting
Articles:
- Url: nservicebus/troubleshooting/message-loss
Expand Down
12 changes: 6 additions & 6 deletions nservicebus/usage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ related:

There are two methods provided for measuring usage of an NServiceBus system:

- [Inbuilt functionality of ServiceControl and ServicePulse](#inbuilt-functionality-of-servicecontrol-and-servicepulse)
- [Endpoint throughput counter tool](#endpoint-throughput-counter-tool)
- [Using ServicePulse](#using-servicepulse)
- [Standalone Endpoint throughput tool](#standalone-endpoint-throughput-tool)

> [!NOTE]
> Requirements for both of the usage measuring methods:
Expand All @@ -20,9 +20,9 @@ There are two methods provided for measuring usage of an NServiceBus system:
The output of the measuring methods is a usage report containing NServiceBus endpoint count and throughput summary. The report is generated as a JSON file which needs to be sent to Particular upon request, usually at license renewal time.

## Inbuilt functionality of ServiceControl and ServicePulse
## Using ServicePulse

The recommended method of measuring the usage of an NServiceBus system is via the [inbuilt functionality of ServiceControl and ServicePulse](/servicepulse/usage.md).
The recommended method of measuring the usage of an NServiceBus system is via [ServicePulse](/servicepulse/usage.md).

> [!NOTE]
> This method requires ServicePulse version 1.39 or later, and ServiceControl version 5.3 or later.
Expand All @@ -32,9 +32,9 @@ This method provides the extra benefits of:
- ability to [view the system usage](/servicepulse/usage.md#viewing-usage-summary) at any time
- ability to optionally [specify if a detected queue should not be included in license pricing](/servicepulse/usage.md#viewing-usage-summary-setting-an-endpoint-type)
- no requirement to run additional tools - [report is generated from a button click in ServicePulse](/servicepulse/usage.md#generating-a-usage-report)
- more accurate usage data
- improved endpoint identification

## Endpoint throughput counter tool
## Standalone Endpoint throughput tool

Customers who are not able to use the latest ServiceControl version can use the [Endpoint throughput counter tool](./../throughput-tool) to measure their system usage.

Expand Down
2 changes: 1 addition & 1 deletion servicecontrol/creating-config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ Type: string
Default: `ServiceControl.ThroughputData`

> [!NOTE]
> These settings do not need to be modified unless MSMQ transport is used with the Monitoring instance installed on a different machine to the ServiceControl Error instance.
> This setting does not need to be modified unless MSMQ transport is used with the Monitoring instance installed on a different machine to the ServiceControl Error instance.
### LicenseComponent/ASB/ServiceBusName

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,4 @@ Type: string
Default: `ServiceControl.ThroughputData`

> [!NOTE]
> These settings do not need to be modified unless MSMQ transport is used with the Monitoring instance installed on a different machine to the ServiceControl Error instance.
> This setting does not need to be modified unless MSMQ transport is used with the Monitoring instance installed on a different machine to the ServiceControl Error instance.
8 changes: 4 additions & 4 deletions servicepulse/usage-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ The follow settings are available to setup a connection to SqlServer:

Refer to the [usage reporting](/servicecontrol/creating-config-file.md#usage-reporting) section of the ServiceControl config file for an explanation of the SqlServer specific settings.

#### Permissions
#### Minimum Permissions

User with rights to query [INFORMATION_SCHEMA].[COLUMNS] table.

Expand All @@ -127,13 +127,13 @@ The follow settings are available to setup a connection to RabbitMQ:

Refer to the [usage reporting](/servicecontrol/creating-config-file.md#usage-reporting) section of the ServiceControl config file for an explanation of the RabbitMQ specific settings.

#### Permissions
#### Minimum Permissions

User with monitoring tag and read permission.

### MSMQ & Azure Storage Queues

MSMQ and Azure Storage Queues do not support quering of metrics. To be able to report on usage in these systems, [Audit](./../servicecontrol/audit-instances) and/or [Monitoring](./../monitoring) need to be enabled on all NServiceBus endpoints.
MSMQ and Azure Storage Queues do not support querying of metrics. To be able to report on usage in these systems, [Audit](./../servicecontrol/audit-instances) and/or [Monitoring](./../monitoring) need to be enabled on all NServiceBus endpoints.

Configure [auditing](./../nservicebus/operations/auditing.md) on all NServiceBus endpoints.

Expand All @@ -145,7 +145,7 @@ The Diagnostics tab helps to diagnose any connection issues to the broker, as we

![usage-setup-diagnostics](images/usage-setup-diagnostics.png "width=600")

After making any setting changes, presss the `Refresh Connection Test` button to see if the problem is resolved.
After making any setting changes, press the `Refresh Connection Test` button to see if the problem is resolved.
If unable to fix the issue, open a [non-critical support case](https://particular.net/support) and include the diagnostic output.

## Report Masks
Expand Down
22 changes: 13 additions & 9 deletions servicepulse/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Usage
summary: Use ServicePulse and ServiceControl to view and measure the usage of an NServiceBus system.
summary: Use ServicePulse to view and measure the usage of an NServiceBus system.
component: ServicePulse
reviewed: 2024-05-08
related:
Expand All @@ -18,34 +18,38 @@ A usage report can be generated here at license renewal time.
## Generating a usage report

Clicking `Generate Report` generates a usage report file with the detected [endpoints](#viewing-usage-summary-detected-endpoints) and [queues](#viewing-usage-summary-detected-broker-queues). The report includes the [endpoint type](#viewing-usage-summary-setting-an-endpoint-type) selections made on screen, and any specified [words to mask](usage-config.md#report-masks) with be obfuscated.
Clicking `Generate Report` generates a usage report file with the detected [endpoints](#viewing-usage-summary-detected-endpoints) and [queues](#viewing-usage-summary-detected-broker-queues). The report includes the [endpoint type](#setting-an-endpoint-type) selections made on screen, and any specified [words to mask](usage-config.md#report-masks) with be obfuscated.

The report **will not** be automatically uploaded or sent to Particular - it is a JSON file that needs to be provided to Particular upon request.

## Viewing usage summary

At any time the system usage can be viewed on the Usage page. It is divided into two sections:

- [detected endpoints](#viewing-usage-summary-detected-endpoints)
- [detected broker queues](#viewing-usage-summary-detected-broker-queues)
- [Detected endpoints](#viewing-usage-summary-detected-endpoints)
- [Detected broker queues](#viewing-usage-summary-detected-broker-queues)

For each endpoint and queue, the maximum daily throughput is displayed. This can be helpful in seeing how the system is growing over time, and hence getting an understanding of which [tier](https://particular.net/pricing) the endpoint belongs to for licensing purposes.

### Detected endpoints

Detected endpoints are those identified by the system as NServiceBus endpoints and are included in usage report for NServiceBus licensing purposes. There is an option to set the endpoint type if there is a valid reason as to why it should not be included in the licensing calculations. Any changes made to the endpoint type are automaically saved.
Detected endpoints are those identified by the system as NServiceBus endpoints and are included in usage report for NServiceBus licensing purposes. There is an option to set the endpoint type if there is a valid reason as to why it should not be included in the licensing calculations. Any changes made to the endpoint type are automatically saved.

### Detected broker queues

This option will not be displayed if the using a non-broker transport.

If the system is using an [NServiceBus transport](./../transports) that allows querying of metrics, then any queues detected on the broker that cannot be automatically identified as NServiceBus endpoints will be listed in the `Detected Broker Queues` tab. These queues will be included in the usage report for NServiceBus licensing purposes.

### Setting an endpoint type
## Setting an endpoint type

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

The usage summary may contain detected queues that should not be counted as part of a license with Particular Software. The raw report data will be processed by a tool that will ignore throughput caused, for example, by ServiceControl and related tools that should not be counted for licensing purposes.
Once a report is submitted to Particular, it is reviewed and any system queues that should not be counted for licensing purposes are removed.

In addition, the detected endpoints and queues screen provides an option to set the endpoint type which provides a reason as to why a queue should not be included in the licensing calculations. Any changes made to the endpoint type are automaically saved.
In addition, the detected endpoints and queues screen provides an option to set the endpoint type, which provides 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.

#### Bulk endpoint updates
### Bulk endpoint updates

If multiple endpoints or queues matching a certain naming pattern need to be set to an endpoint type, then this can be done in bulk using the filter option.

Expand Down

0 comments on commit 447a72d

Please sign in to comment.