Configuring Service Bus

Note

Before any monitoring and remote configuration can be performed, you must first install the Message Queueing Monitoring Agent and create a Monitoring Agent Configuration. First-time users start here.

Monitoring the Azure Service Bus requires some steps to authenticate with the Azure REST API make sure to first read the Azure Application Access page.

From the Service Bus tab you can manage any number of Azure Subscriptions; Each with its own set of properties.

Here's an example of the Service Bus Tab where you configure Azure Subscriptions to monitor

• Add Service Bus Subscription
• Remove Service Bus Subscription
• Enable Service Bus Subscription
• Disable Service Bus Subscription
• Edit Service Bus Configuration
  • Manage Queue thresholds
    • Global - Use if not overridden by a specific setting
    • Specific - Overrides global configuration on named queue
    • Apply exclusion filters
• Resource groups
• Authentication

Remember to click on the Save button to persist changes. It may take some time (depending on the user-defined synchronization interval) for Nodinite to reflect on changes.

Add Service Bus Subscription

click the Add button to add a new Azure Subscription with Azure Service Bus Resources to Monitor, repeat as needed.

Click Add button to add Azure Subscription.

Here's an example of new entry.

Next, follow the steps in the Edit Service Bus Configuration section below.

Remove Service Bus Subscription

Click the Remove button to remove the configuration for monitoring the Azure Subscription with Azure Service Bus Resources to Monitor.

Here's an example of Remove button to remove Azure Subscription configuration from monitoring.

Instead of removing an Azure Subscription, you can simply disable monitoring. By doing so, you will keep your configuration.

Enable Service Bus Subscription

A disabled Monitoring Configuration is clearly marked with a ban sign. Only disabled subscriptions can be Enabled.

Disabled subscriptions have a ban sign to mark that the subscription is not actively monitored.

Click the checkbox to re-enable monitoring of Azure Service Bus related Resources.

Service Bus Monitoring is enabled when the checkbox is checked.

Disable Service Bus Subscription

You can stop monitoring the Service Bus without removing the configuration by disabling the selected configuration. An enabled Monitoring Configuration does not have a ban sign. Only enabled subscriptions can be Disabled.

Enabled subscriptions do not have a ban sign.

Un-check the checkbox to disable monitoring of Azure Service Bus related Resources.

Edit Service Bus Configuration

Click the accordion to open the entry to start editing the connection. Configurable properties are separated within the following tabs:

• Basic
• Queue Thresholds
• Topic Thresholds
• Resource groups
• Authentication

Basic tab

You need to first provide the following general information in the Basic tab:

Edit the connection information for your Azure Subscription with Azure Service Bus related resources

• Enable Service Bus monitoring - When checked, the configured Service Bus will be monitored
• Configuration Name - The user-friendly name for this Azure Subscription Entry
  • The Name is used as the Resource Name for the Service Bus Category
• Description - Text where you can provide additional information about this entry

Queue Thresholds tab

From within the Thresholds tab, you can manage the following queue monitoring properties :

• 1. Global - Default values used when not overridden by a specific setting
• 2. Specific queue settings - Overrides global configuration on named queue
• 3. Queue exclusion filter - use one or more RegEx expressions to remove queues you do not want to monitor

Queue tab with global and specific thresholds.

You can provide different global thresholds for different configurations (e.g. different subscriptions).

Global thresholds for Azure Service Bus Queues.

The following settings are available:

• Count Evaluation Type
  • None
  • Fixed
  • Percentage
  • Which comes first (both)
• Time-based evaluation

Here's an example of the Count Evaluation Type.

Time-based evaluation

Time-based evaluation is always evaluated. If you do not want to perform an evaluation based on time then simply provide long enough thresholds.

None

If you select the None option for Count Evaluation Type then monitoring is not based on the number of messages in the queue.

Fixed

If you select the Fixed option for Count Evaluation Type then monitoring is based on the number of messages in the queue.

Percentage

If you select the Percentage option for Count Evaluation Type then monitoring is based on the quota set for the queue.

Which comes first (both)

If you select the Which comes first (both) option for Count Evaluation Type then monitoring is based on both Fixed and Percent.

Specific queue settings

You can provide specific thresholds for named service bus queues belonging for each subscription.

Add one or more named queues to provide specific settings.

Each specific queue needs to be identified by its namespace and queue name. You can also provide a user-friendly description.

The rest of the properties are the same as already described in the global configuration.

Tip

It is much easier to perform specific configurations using the Edit threshold menu item available on the Actions button in the list of queues (Resources) with Monitor Views with Remote Actions Option checked.

Queue exclusion filter

The Queue exclusion filter feature provides a means for you to use one or more RegEx expressions to remove queues that you want to exclude from being monitored.

Whenever you apply one or more filters the configuration accordion will reflect this by displaying a filter icon to help you know there is an exclusion filter being used.

Here's an example of filter icon whenever exclusions are configured.

You can Add and Remove as many RegEx expressions as you like.

Important

We have had many support incidents with reports of missing queues due to this functionality. If you miss out a queue in your Monitor Views then first make sure your filters are not the ones responsible for this. Remember; With great power comes great responsibility

Topic Thresholds tab

From within the Topic Thresholds tab, you can manage the following topic monitoring properties :

• 1. Global - Default values used when not overridden by a specific setting
• 2. Specific queue settings - Overrides global configuration on named topic
• 3. Queue exclusion filter - use one or more RegEx expressions to remove topics you do not want to monitor

Topic tab with global and specific thresholds.

You can provide different global thresholds for different configurations (e.g. different subscriptions)

Global thresholds for Azure Service Bus Topics.

The following settings are available:

• Count Evaluation Type
  • None
  • Fixed
• Time-based evaluation

Here's an example of the Count Evaluation Type.

Time-based evaluation

Time-based evaluation is always evaluated. If you do not want to perform an evaluation based on time then simply provide long enough thresholds.

None

If you select the None option for Count Evaluation Type then monitoring is not based on the number of messages at the topic/subscription.

Fixed

If you select the Fixed option for Count Evaluation Type then monitoring is based on the number of messages at the topic/subscription.

Specific Topic settings

You can provide specific thresholds for named service bus topic (affects all subscriptions for that topic).

Add one or more named topics to provide specific settings

Each specific topic needs to be identified by its namespace and topic name. You can also provide a user-friendly description.

The rest of the properties are the same as already described in the global configuration.

Tip

It is much easier to perform specific configurations using the Edit threshold menu item available on the Actions button in the list of topics (Resources) with Monitor Views with Remote Actions Option checked.

Topic exclusion filter

The Topic exclusion filter feature provides a means for you to use one or more RegEx expressions to remove topics that you want to exclude from being monitored.

Whenever you apply one or more filters the configuration accordion will reflect this by displaying a filter icon to help you know there is an exclusion filter being used.

Here's an example of filter icon whenever exclusions are configured

You can Add and Remove as many RegEx expressions as you like.

Important

We have had many support incidents with reports of missing queues due to this functionality. If you miss out a queue in your Monitor Views then first make sure your filters are not the ones responsible for this. Remember; With great power comes great responsibility

Resource Groups tab

You can opt to only include Service Bus Resources from named Azure Resource Groups. These are also monitored with their own Category; "Resource Group". This means that if someone renames or removes a Resource group from the Azure Subscription, you will be alerted(!).

Here's an example of the Resource Groups tab.

Click the accordion to expand the configuration. You must set the name of the Resource group to include.

Here's an example of Resource group to include in monitoring

Repeat for all named Resource groups to monitor as required by your business case.

Here's an example of filtered Monitor View by category Resource Group

Authentication tab

Monitoring the Azure Service Bus requires some steps to authenticate with the Azure REST API make sure to first read the Azure Application Access page

• TenantId
• SubscriptionId
• ClientId
• ClientSecret

If you provide invalid credentials you will see this in the Monitor View since each configuration is presented as a Resource by Category Service Bus Configuration.

Remember to click on the Save button to persist changes.

---

Next Step

• Configuration of the agent
  • Configuring ActiveMQ
  • Configuring MSMQ
  • Configuring AnypointMQ
• Add or manage Monitor View

Related Topics

Add or manage a Monitoring Agent Configuration
Install Message Queueing Monitoring Agent