Skip to content

Commit 41d1f99

Browse files
spelluruspelluru
committed
update
1 parent 5de10ea commit 41d1f99

File tree

1 file changed

+185
-0
lines changed

1 file changed

+185
-0
lines changed

‎articles/azure-monitor/insights/service-bus-insights-overview.md

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
---
2+
title: Monitor Azure Service Bus with Azure Monitor insights
3+
description: This article describes the Service Bus insights feature of Azure Monitor that provides Service Bus consumers with a quick understanding of performance issues.
4+
ms.topic: conceptual
5+
ms.date: 11/16/2021
6+
7+
---
8+
9+
# Azure Monitor - Service Bus insights
10+
Azure Service Bus insights provide a view of the overall performance, failures, capacity, and operational health of all your Service Bus resources in a unified interactive experience. This article will help you understand the benefits of this new monitoring experience, and how you can modify and adapt the experience to fit the unique needs of your organization.
11+
12+
## Introduction
13+
14+
Before diving into the experience, you should understand how it presents and visualizes information.
15+
16+
It delivers:
17+
18+
* **At scale perspective** of your Service Bus resources across all your subscriptions in a single location, with the ability to selectively scope to only those subscriptions and resources you're interested in evaluating.
19+
20+
* **Drill down analysis** of a particular Service Bus resource to help diagnose issues or perform detailed analysis by category - utilization, failures, capacity, and operations. Selecting any one of those options provides an in-depth view of the relevant information.
21+
22+
* **Customizable** - This experience is built on top of Azure Monitor workbook templates allowing you to change what metrics are displayed, modify or set thresholds that align with your limits, and then save into a custom workbook. Charts in the workbooks can then be pinned to Azure dashboards.
23+
24+
This feature doesn't require you to enable or configure anything, these Service Bus metrics are collected by default.
25+
26+
>[!NOTE]
27+
>There is no charge to access this feature and you will only be charged for the Azure Monitor essential features you configure or enable, as described on the [Azure Monitor pricing details](https://azure.microsoft.com/pricing/details/monitor/) page.
28+
29+
## View utilization and performance metrics for Service Bus
30+
31+
To view the utilization and performance of your Service Bus resources across all of your subscriptions, perform the following steps.
32+
33+
1. Sign in to the [Azure portal](https://portal.azure.com).
34+
35+
2. Search for **Monitor** and select **Monitor**.
36+
37+
![Search box with the word "Monitor" and a dropdown that says Services "Monitor" with a speedometer style image](./media/service-bus-insights/search-monitor.png)
38+
39+
3. On the left menu, select **Service Bus (preview)**.
40+
41+
:::image type="content" source="./media/service-bus-insights/service-bus.png" lightbox="./media/service-bus-insights/service-bus.png" alt-text="Screenshot of Service Bus Insights page.":::
42+
43+
### Overview
44+
45+
On **Overview**, the table displays interactive Service Bus metrics. You can filter the results based on the options you select from the following drop-down lists:
46+
47+
* **Subscriptions** - only subscriptions that have a Service Bus resource are listed.
48+
49+
* **Service Bus** - You can select all, a subset, or single Service Bus resource.
50+
51+
* **Time Range** - by default, displays the last 4 hours of information based on the corresponding selections made.
52+
53+
The counter tile under the drop-down lists rolls-up the total number of Service Bus resources are in the selected subscriptions. There's conditional color-coding or heatmaps for columns in the workbook that report transaction metrics. The deepest color has the highest value and a lighter color is based on the lowest values.
54+
55+
The **Overview** page shows you the following values and also the timeline for active connections.
56+
57+
| Metric Name | Description |
58+
| ---------- | ---------- |
59+
|Active Connections| The number of active connections on a namespace and on an entity in the namespace. Value for this metric is a point-in-time value. Connections that were active immediately after that point-in-time may not be reflected in the metric. |
60+
|Connections Opened | The number of open connections. |
61+
|Connections Closed | The number of closed connections. |
62+
|Successful Requests| The number of successful requests made to the Service Bus service over a specified period. |
63+
|Throttled Requests| The number of requests that were throttled because the usage was exceeded. |
64+
65+
For more information about these metrics, see [Service Bus metrics](../../service-bus-messaging/monitor-service-bus-reference.md).
66+
67+
Selecting the Service Bus resource name highlighted in blue will take you to the default **Overview** for that resource.
68+
69+
### Requests
70+
71+
Select **Requests** at the top of the page and the **Requests** portion of the workbook template opens.
72+
73+
:::image type="content" source="./media/service-bus-insights/service-bus-requests.png" lightbox="./media/service-bus-insights/service-bus-requests.png" alt-text="Screenshot of the Requests tab of Service Bus Insights page.":::
74+
75+
This page shows you the following values and also the timeline for incoming requests.
76+
77+
| Metric Name | Description |
78+
| ---------- | ---------- |
79+
| Incoming Requests| The number of requests made to the Service Bus service over a specified period. |
80+
|Successful Requests| The number of successful requests made to the Service Bus service over a specified period. |
81+
|Throttled Requests| The number of requests that were throttled because the usage was exceeded. |
82+
|Server Errors| The number of requests not processed because of an error in the Service Bus service over a specified period. |
83+
|User Errors | The number of requests not processed because of user errors over a specified period. |
84+
85+
For more information about these metrics, see [Service Bus - request metrics](../../service-bus-messaging/monitor-service-bus-reference.md#request-metrics).
86+
87+
88+
### Messages
89+
90+
Select **Messages** at the top of the page and the **Messages** portion of the workbook template opens.
91+
92+
:::image type="content" source="./media/service-bus-insights/service-bus-messages.png" lightbox="./media/service-bus-insights/service-bus-messages.png" alt-text="Screenshot of the Messages tab of Service Bus Insights page.":::
93+
94+
This page shows you the following values and also the timeline for incoming messages.
95+
96+
| Metric Name | Description |
97+
| ---------- | ---------- |
98+
|Incoming Messages| The number of messages sent to Service Bus over a specified period. This metric doesn't include messages that are auto forwarded. |
99+
|Outgoing Messages| The number of messages received from Service Bus over a specified period. |
100+
| Messages| Count of messages in a queue/topic. |
101+
| Scheduled messages| Count of scheduled messages in a queue/topic. |
102+
103+
For more information about these metrics, see [Service Bus - message metrics](../../service-bus-messaging/monitor-service-bus-reference.md#message-metrics).
104+
105+
106+
## View from a Service Bus resource
107+
108+
1. In the Azure portal, search for **Service Bus**, and select any of your existing Service Bus namespaces.
109+
2. On the **Service Bus Namespace** page, in the **Monitoring** section on the left menu, select **Insights (preview)** or **Workbooks** to do further analysis. You see the following page when you select **Insights (preview)**.
110+
111+
:::image type="content" source="./media/service-bus-insights/service-bus-overview.png" lightbox="./media/service-bus-insights/service-bus-overview.png" alt-text="Screenshot of Service Bus Insights Overview.":::
112+
113+
You see the same tabs (**Overview**, **Requests**, and **Messages**) on this page, similar to the ones you see on the **Azure Monitor - Service Bus (Preview)** page. You'll see more information on these tabs compared to the ones on the Azure Monitor page though.
114+
115+
> [!NOTE]
116+
> For more information about metrics you see on this page, see [Service Bus metrics](../../service-bus-messaging/monitor-service-bus-reference.md).
117+
118+
### Overview tab
119+
You see the following information for the Service Bus **namespace** for the selected **time range**: number of active connections, connections opened, successful requests, throttled requests, and incoming messages.
120+
121+
You also see charts with the following information for the namespace over time in the selected time range: active connections, connections opened and closed, successful requests, throttled requests, and incoming & outgoing messages. For example, the **Active Connections** chart shows the number of active connections in the last 4 hours (selected time range).
122+
123+
:::image type="content" source="./media/service-bus-insights/service-bus-overview.png" lightbox="./media/service-bus-insights/service-bus-overview.png" alt-text="Screenshot of Service Bus Insights Overview.":::
124+
125+
### Requests tab
126+
You see the following information for the Service Bus **namespace** for the selected **time range**: number of incoming requests, successful requests, server errors, user errors, and throttled requests.
127+
128+
The table that follows this section shows break down of these values for each resource (queue or topic) in the Service Bus namespace.
129+
130+
This page also has charts showing the following information for the namespace over time in the selected time range:
131+
132+
- Incoming, successful, and throttled requests for all queues and topics in the namespace, and for each queue or topic (segment) in the namespace
133+
- Server and user errors for all queues and topics in the namespace, and for each queue or topic (segment) in the namespace.
134+
135+
136+
### Messages tab
137+
You see the following information for the Service Bus **namespace** for the selected **time range**:
138+
139+
- Number of incoming, outgoing, and dead-lettered messages for all queues and topics in the namespace.
140+
- Average number of messages, active messages, and scheduled messages for all queues and topics in the namespace.
141+
142+
The table that follows this section shows break down of these values for each resource (queue or topic) in the Service Bus namespace.
143+
144+
This page also has charts showing the following information for the namespace over time in the selected time range:
145+
146+
- Incoming, outgoing, all, active, scheduled, and dead-lettered messages for all entities (queues and topics) in the namespace.
147+
- Breakdown of above metrics by segment or entity (queue or topic in the namespace)
148+
149+
150+
### Time range
151+
152+
By default, the **Time Range** field displays data from the **Last 4 hours**. You can modify the time range to display data anywhere from the last 5 minutes to the last seven days. The time range selector also includes a **Custom** mode that allows you to type in the start/end dates to view a custom time frame based on available data for the selected account.
153+
154+
:::image type="content" source="./media/service-bus-insights/service-bus-time-range.png" alt-text="Screenshot showing selection of time range.":::
155+
156+
## Pin and export
157+
158+
You can pin any one of the metric sections to an [Azure Dashboard](../../azure-portal/azure-portal-dashboards.md) by selecting the pushpin icon at the top right of the section.
159+
160+
:::image type="content" source="./media/service-bus-insights/pin.png" alt-text="Screenshot that shows the Pin button at the top of the section.":::
161+
162+
To export your data into the Excel format, select the down arrow icon to the left of the pushpin icon.
163+
164+
:::image type="content" source="./media/service-bus-insights/export-excel.png" alt-text="Screenshot showing the selection of the Export workbook button on the toolbar.":::
165+
166+
167+
## Customize Service Bus insights
168+
169+
Since this experience is built on top of Azure Monitor workbook templates, you can customize it by selecting **Customize** on the toolbar.
170+
171+
:::image type="content" source="./media/service-bus-insights/customize.png" alt-text="Screenshot showing the selection of the Customize button on the toolbar.":::
172+
173+
On the **Service Bus Overview - Azure Monitor** page, select **Edit** to make modifications, and **Save** a copy of your modified version into a custom workbook. Select **Workbooks** on the toolbar to see the gallery of workbooks including the one you saved.
174+
175+
:::image type="content" source="./media/service-bus-insights/workbooks.png" alt-text="Screenshot showing the selection of Workbooks toolbar button.":::
176+
177+
## Troubleshooting
178+
179+
For troubleshooting guidance, refer to the dedicated workbook-based insights [troubleshooting article](troubleshoot-workbooks.md).
180+
181+
## Next steps
182+
183+
* Configure [metric alerts](../alerts/alerts-metric.md) and [service health notifications](../../service-health/alerts-activity-log-service-notifications-portal.md) to set up automated alerting to aid in detecting issues.
184+
185+
* Learn the scenarios workbooks are designed to support, how to author new and customize existing reports, and more by reviewing [Create interactive reports with Azure Monitor workbooks](../visualize/workbooks-overview.md).

0 commit comments

Comments
 (0)