Skip to content

Commit de6bff4

Browse files
sachin-sumologicsachin-sumologic
committed
Azure Service Bus Documentation
1 parent b503131 commit de6bff4

File tree

5 files changed

+208
-13
lines changed

5 files changed

+208
-13
lines changed

‎docs/integrations/microsoft-azure/azure-api-management.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ If this rule already exists, there is no need to create it again.
112112
| service_type | $resourceId._6 |
113113
| service_name | $resourceId._7 |
114114
115-
#### Azure observability metadata extraction application gateway level
115+
#### Azure observability metadata extraction azure api level
116116
117117
```sql
118-
Rule Name: AzureObservabilityMetadataExtractionAppGatewayLevel
118+
Rule Name: AzureObservabilityMetadataExtractionAzureAPIManagementLevel
119119
```
120120
121121
```sql title="Metric match expression"
122-
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/APPLICATIONGATEWAYS/* tenant_name=*
122+
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.APIMANAGEMENT/SERVICE/* tenant_name=*
123123
```
124124
| Fields extracted | Metric rule |
125125
|:------------------|:------------------------|
@@ -139,7 +139,7 @@ In this section, you will configure a pipeline for shipping metrics from Azure M
139139
1. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform below steps for each Azure API Management that you want to monitor.
140140
1. Choose `Stream to an event hub` as destination.
141141
1. Select `AllMetrics`.
142-
1. Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name. <br/><img src={useBaseUrl('img/send-data/azure-apimanagement-metrics.png')} alt="Azure application gateway metrics" style={{border: '1px solid gray'}} width="800" />
142+
1. Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name. <br/><img src={useBaseUrl('img/send-data/azure-apimanagement-metrics.png')} alt="Azure api management metrics" style={{border: '1px solid gray'}} width="800" />
143143
1. Tag the location field in the source with right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure API Management Tag Location" style={{border: '1px solid gray'}} width="400" />
144144
145145
:::note
@@ -153,7 +153,7 @@ In the v2 service tiers, API Management has replaced the capacity metric with se
153153
In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.
154154
155155
1. To set up the Azure Event Hubs source in Sumo Logic, refer to the [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
156-
1. To create the diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/data-factory/monitor-configure-diagnostics). Perform the steps below for each Azure application gateway account that you want to monitor.
156+
1. To create the diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/data-factory/monitor-configure-diagnostics). Perform the steps below for each Azure api management account that you want to monitor.
157157
1. Choose **Stream to an event hub** as the destination.
158158
1. Select `allLogs`.
159159
1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azure-apimanagement-logs.png')} alt="Azure API Management logs" style={{border: '1px solid gray'}} width="800" />

‎docs/integrations/microsoft-azure/azure-service-bus.md‎

Lines changed: 203 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1313
## Log and metric types
1414

1515
For Azure Service Bus, you can collect the following logs and metrics:
16-
17-
* **Resource logs**. To learn more about the different resource log category types and schemas collected for Azure Service Bus, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/monitor-service-bus-reference#resource-logs).
16+
* **Operational Logs**. To learn more about the resource log schema for Azure Service Bus, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/monitor-service-bus-reference#resource-logs).
17+
* **VNet And IP Filtering Logs**. To learn more about the resource log schema for Azure Service Bus, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/monitor-service-bus-reference#resource-logs).
18+
* **Runtime Audit Logs**. To learn more about the resource log schema for Azure Service Bus, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/monitor-service-bus-reference#runtime-audit-logs).
19+
* **Diagnostic Error Logs**. To learn more about the resource log schema for Azure Service Bus, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/monitor-service-bus-reference#diagnostic-error-logs).
1820
* **Platform Metrics for Azure Service Bus**. These metrics are available in [Microsoft.ServiceBus/namespaces](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-servicebus-namespaces-metrics) namespace. For more information on supported metrics and dimensions, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/monitor-service-bus-reference#metrics).
1921

2022
## Setup
@@ -28,6 +30,105 @@ You must explicitly enable diagnostic settings for each Azure Service Bus namesp
2830

2931
When you configure the event hubs source or HTTP source, plan your source category to ease the querying process. A hierarchical approach allows you to make use of wildcards. For example: `Azure/ServiceBus/Logs`, `Azure/ServiceBus/Metrics`.
3032

33+
### Configure field in field schema
34+
35+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
36+
1. Search for the following fields:
37+
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
38+
- `location`. The region to which the resource name belongs to.
39+
- `subscription_id`. ID associated with a subscription where the resource is present.
40+
- `resource_group`. The resource group name where the Azure resource is present.
41+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
42+
- `resource_type`. Azure resource type (for example, storage accounts).
43+
- `resource_name`. The name of the resource (for example, storage account name).
44+
- `service_type`. Type of the service that can be accessed with a Azure resource.
45+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Service Bus service is Subscriptions).
46+
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
47+
48+
### Configure field extraction rules
49+
50+
Create the following Field Extraction Rule(s) (FER) for Azure Storage by following the instructions in [Create a Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule/).
51+
52+
#### Azure location extraction FER
53+
54+
```sql
55+
Rule Name: AzureLocationExtractionFER
56+
Applied at: Ingest Time
57+
Scope (Specific Data): tenant_name=*
58+
```
59+
60+
```sql title="Parse Expression"
61+
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
62+
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
63+
| if (!isBlank(resourceLocation), resourceLocation, location) as location
64+
| if (!isBlank(service_region), service_region, location) as location
65+
| if (isBlank(location), "global", location) as location
66+
| fields location
67+
```
68+
69+
#### Resource ID extraction FER
70+
71+
```sql
72+
Rule Name: AzureResourceIdExtractionFER
73+
Applied at: Ingest Time
74+
Scope (Specific Data): tenant_name=*
75+
```
76+
77+
```sql title="Parse Expression"
78+
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
79+
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
80+
| toUpperCase(resourceId) as resourceId
81+
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
82+
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
83+
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
84+
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
85+
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
86+
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
87+
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
88+
```
89+
90+
### Configure metric rules
91+
92+
Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule).
93+
94+
#### Azure observability metadata extraction service level
95+
96+
If this rule already exists, there is no need to create it again.
97+
98+
```sql
99+
Rule Name: AzureObservabilityMetadataExtractionServiceLevel
100+
```
101+
102+
```sql title="Metric match expression"
103+
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/*/*/*/* tenant_name=*
104+
```
105+
| Fields extracted | Metric rule |
106+
|------------------|----------------|
107+
| subscription_id | $resourceId._1 |
108+
| resource_group | $resourceId._2 |
109+
| provider_name | $resourceId._3 |
110+
| resource_type | $resourceId._4 |
111+
| resource_name | $resourceId._5 |
112+
| service_type | $resourceId._6 |
113+
| service_name | $resourceId._7 |
114+
115+
#### Azure observability metadata extraction service bus level
116+
117+
```sql
118+
Rule Name: AzureObservabilityMetadataExtractionAzureServiceBusLevel
119+
```
120+
121+
```sql title="Metric match expression"
122+
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/* tenant_name=*
123+
```
124+
| Fields extracted | Metric rule |
125+
|:------------------|:----------------------|
126+
| subscription_id | $resourceId._1 |
127+
| resource_group | $resourceId._2 |
128+
| provider_name | MICROSOFT.SERVICEBUS |
129+
| resource_type | NAMESPACES |
130+
| resource_name | $resourceId._3 |
131+
31132
### Configure metrics collection
32133
33134
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
@@ -37,17 +138,111 @@ In this section, you will configure a pipeline for shipping metrics from Azure M
37138
3. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform below steps for each Azure Service Bus namespace that you want to monitor.
38139
* Choose `Stream to an event hub` as destination.
39140
* Select `AllMetrics`.
40-
* Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.
141+
* Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azure-service-bus-metrics.png')} alt="Azure service bus metrics" style={{border: '1px solid gray'}} width="800" />
142+
* Tag the location and entityname fields in the source with right values. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Service-Bus-Tag-Metric-Fields.png')} alt="Azure Service Bus Tag location and entityname" style={{border: '1px solid gray'}} width="400" />
41143
42144
### Configure logs collection
43145
44146
In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.
45-
147+
#### Diagnostic logs
46148
1. To set up the Azure Event Hubs source in Sumo Logic, refer to [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
47-
2. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#create-diagnostic-settings). Perform below steps for each Azure Service Bus namespace that you want to monitor.
48-
* Choose `Stream to an event hub` as the destination.
49-
* Select `allLogs`.
50-
* Use the Event hub namespace and Event hub name configured in previous step in destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.
149+
1. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#create-diagnostic-settings). Perform below steps for each Azure Service Bus namespace that you want to monitor.
150+
1. Choose `Stream to an event hub` as the destination.
151+
1. Select `allLogs`.
152+
1. Use the Event hub namespace and Event hub name configured in previous step in destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.
153+
1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azure-servicebus-logs.png')} alt="Azure Service Bus logs" style={{border: '1px solid gray'}} width="800" />
154+
1. Tag the location field in the source with right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Service Bus Tag Location" style={{border: '1px solid gray'}} width="400" />
155+
156+
#### Activity Logs
157+
158+
To collect activity logs, follow the instructions [here](/docs/integrations/microsoft-azure/audit). Do not perform this step in case you are already collecting activity logs for a subscription.
159+
160+
:::note
161+
Since this source contains logs from multiple regions, make sure that you do not tag this source with the location tag.
162+
:::
163+
164+
165+
## Viewing the Azure Service Bus dashboards
166+
167+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
168+
169+
<ViewDashboards/>
170+
171+
### Overview
172+
173+
The **Azure Service Bus - Overview** provides details on the overall performance and usage of your Azure Service Bus namespaces.
174+
175+
Use this dashboard to:
176+
* Monitor namespace resource utilization like CPU and memory usage across different locations.
177+
* Track message processing trends by analyzing incoming vs outgoing message differences, total errors and Average Server Send Latency over time.
178+
179+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureServiceBus/Azure-Service-Bus-Overview.png')} alt="Azure Service Bus - Overview" style={{border: '1px solid gray'}} width="800" />
180+
181+
182+
### Administrative Operations
183+
184+
The **Azure Service Bus - Administrative Operations** provides an overview of management activities performed on your Azure Service Bus namespaces.
185+
186+
Use this dashboard to:
187+
* Monitor the distribution of read, write, and delete operations across your service bus namespaces.
188+
* Identify and investigate errors occurring during administrative operations to maintain optimal service bus configuration.
189+
190+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureServiceBus/Azure-Service-Bus-Administrative-Operations.png')} alt="Azure Service Bus - Overview" style={{border: '1px solid gray'}} width="800" />
191+
192+
193+
### Errors
194+
195+
The **Azure Service Bus - Errors** provides details on various error types, failed operations, and error messages related to Azure Service Bus.
196+
197+
Use this dashboard to:
198+
* Identify and troubleshoot common error patterns by analyzing the trend of user errors and server errors.
199+
* Monitor message processing issues by tracking dead-lettered and abandoned messages over time.
200+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureServiceBus/Azure-Service-Bus-Errors.png')} alt="Azure Service Bus - Overview" style={{border: '1px solid gray'}} width="800" />
201+
202+
203+
### Messages
204+
205+
The **Azure Service Bus - Messages** provides a detailed view of message flow and status within your Azure Service Bus namespaces.
206+
207+
Use this dashboard to:
208+
* Monitor the volume and status of messages across different categories like active, completed, and abandoned messages.
209+
* Identify potential bottlenecks by comparing incoming and outgoing message rates.
210+
211+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureServiceBus/Azure-Service-Bus-Messages.png')} alt="Azure Service Bus - Overview" style={{border: '1px solid gray'}} width="800" />
212+
213+
214+
### Policy and Recommendation
215+
216+
The **Azure Service Bus - Policy and Recommendation** provides information on policy enforcement and recommendations for your Azure Service Bus namespaces.
217+
218+
Use this dashboard to:
219+
* Review policy success and failure events to ensure proper policy enforcement and security.
220+
* Identify recommendations to improve the performance and security of your Service Bus instances.
221+
222+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureServiceBus/Azure-Service-Bus-Policy-and-Recommendation.png')} alt="Azure Service Bus - Overview" style={{border: '1px solid gray'}} width="800" />
223+
224+
225+
### Traffic
226+
227+
The **Azure Service Bus - Traffic** provides insights into the network traffic and connections of your Azure Service Bus namespaces.
228+
229+
Use this dashboard to:
230+
* Track active connections and analyze connection patterns over time.
231+
* Monitor server send latency and identify any performance issues affecting message delivery.
232+
233+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureServiceBus/Azure-Service-Bus-Traffic.png')} alt="Azure Service Bus - Overview" style={{border: '1px solid gray'}} width="800" />
234+
235+
## Upgrade/Downgrade the Azure Service Bus app (optional)
236+
237+
import AppUpdate from '../../reuse/apps/app-update.md';
238+
239+
<AppUpdate/>
240+
241+
## Uninstalling the Azure Service Bus app (optional)
242+
243+
import AppUninstall from '../../reuse/apps/app-uninstall.md';
244+
245+
<AppUninstall/>
51246
52247
## Troubleshooting
53248

‎static/img/integrations/microsoft-azure/Azure-Service-Bus-Tag-Metric-Fields.png‎

31.4 KB
Loading

‎static/img/send-data/azure-service-bus-metrics.png‎

256 KB
Loading

‎static/img/send-data/azure-servicebus-logs.png‎

278 KB
Loading

0 commit comments

Comments
 (0)