In this article:
- Configure monitoring for Topics in ServiceBus360
- What are the different parameters you can use to monitor the Topic?
- In-depth view of Monitoring Dashboard
Configure monitoring for Topic in ServiceBus360?
To configure monitoring, the user must create alarms and then associate topics to the alarms.
Create an alarm:
- From the Dashboard, click Manage Namespace button of a namespace for which you want to create the alarm. The namespace should be of type ‘Messaging’.
- Click Alarms from the menu on the left.
- Click the Add Alarm button. The Add Alarm blade slides open.
- Enter Alarm Name.
- Enter a summary for the alarm. (This is optional).
- Click the Next button to navigate to the ‘Threshold Violations’ page.
- Click ‘Alert on threshold violation’ to turn on the feature. You can configure alerts for threshold violations in this section.
- Click the Next button to navigate to the ‘Health Monitoring’ page.
- Click ‘Enable Health Monitoring’ to turn on the feature. Enabling health monitoring allows users to get regular alerts on the status of the resource.
- Click Next to navigate to the ‘Notifications Channels’ page. By default, a notification email is sent from ServiceBus360 to the registered email ID (customizable) when the alarm is triggered due to a violation. You can also configure additional notification channels.
- Click the Save button to create the alarm.
Associate the newly created alarm to a topic
- Click Topics from the menu on the left.
- Click the Monitoring icon on the right for the Topic you want to associate the alarm.
- The Select Alarm drop-down on the top left lists all the configured alarms. Select the alarm you want to associate with this topic from the drop-down.
- By default, the parameters of the Topic are displayed. To monitor the status of the Topic, click the Enable Monitor switch for the property ‘Status’. Click the Edit button to change the Expected State and click Save.
- To enable monitoring for subscriptions, click the ‘+ Subscriptions’ button.
- A new blade slides open. Select the subscription from the dropdown and check the parameters you want to monitor for that subscription. You can repeat this for other subscriptions in the drop-down.
- Click ‘Add to Monitor’ button when done.
What are the different parameters you can use to monitor the Topic-Subscription?
ServiceBus360 offers two different kinds of monitoring, viz. state based and value based.
In state-based monitoring, if the state of the messaging entity does not match the expected state, then the alarm is triggered.
State of the Topic-Subscription
- Topic-subscriptions can be in four different states:
- Active: The status of the messaging entity is active.
- Disabled: The status of the messaging entity is disabled.
- SendDisabled: The sending status of the messaging entity is disabled.
- ReceiveDisabled: The receiving status of the messaging entity is disabled.
The availability statuses of subscriptions are:
- Available: The entity is available.
- Limited: The entity is limited.
- Restoring: Resuming the previous status of the entity or the entity is being restored.
- Renaming: The entity is being renamed.
- Unknown: The entity is unknown.
In value-based monitoring, the parameters can be set to trigger an alarm if the current value of the parameter does not match the desired condition. The following parameters are available for configuring.
- Size in Bytes - Size of the Topic in bytes.
- Active Message Count - Number of active messages in the entity.
- Dead Letter Message Count - Number of dead-letter messages in the entity.
- Scheduled Message Count - Number of scheduled messages in the entity.
- Transfer Dead Letter Message Count - Number of messages dead-lettered.
- Transfer Message Count - Number of messages transferred to another entity.
In-depth view of Monitoring Dashboard
The Monitoring Dashboard shows a quick view of all the entities associated with an alarm. When all the parameters of the entity configured are in the desired state, then the status of the entity is Healthy and color-coded green. If even one of the parameters violates the defined threshold value or expected state, then the status of the entity is set to Warning or Error depending on the violation.
- Click Monitoring Dashboard from the left menu bar.
- Click the Select Alarm drop-down box. All the alarms are listed down.
- Select an alarm from the list. All the entities associated with the alarm are displayed.
- If an entity is in Warning or Error state, click on the Issues icon in the extreme right of the table to view the errors in detail.
- You can also Navigate to the Monitoring page of that entity by clicking on the entity name.
- If an entity associated with an alarm has been deleted from the namespace, then the alarm is orphaned. To removed orphaned alarms, click the Remove Orphaned button on the top right.