Skip to content

Commit 81a2ba3

Browse files
Updating Azure service bus app doc wrt Beta metric source
1 parent b70bd76 commit 81a2ba3

File tree

1 file changed

+35
-113
lines changed

1 file changed

+35
-113
lines changed

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

Lines changed: 35 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -24,123 +24,16 @@ For Azure Service Bus, you can collect the following logs and metrics:
2424
Azure service sends monitoring data to Azure Monitor, which can then [stream data to Eventhub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/stream-monitoring-data-event-hubs). Sumo Logic supports:
2525

2626
* Logs collection from [Azure Monitor](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-get-started) using our [Azure Event Hubs source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
27-
* Metrics collection using our [HTTP Logs and Metrics source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/) via Azure Functions deployed using the ARM template.
27+
* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
2828

2929
You must explicitly enable diagnostic settings for each Azure Service Bus namespace you want to monitor. You can forward logs to the same Event Hub provided they satisfy the limitations and permissions as described [here](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#destination-limitations).
3030

3131
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`.
3232

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.
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 an 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-
13233
### Configure metrics collection
13334

134-
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, onto an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
35+
To set up the Azure Metrics source in Sumo Logic, refer to [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
13536

136-
1. Create a hosted collector and tag the `tenant_name` field. 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). <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Tenant-Name.png')} alt="Azure Tag Tenant Name" style={{border: '1px solid gray'}} width="500" />
137-
1. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
138-
1. [Configure and deploy the ARM Template](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-2-configure-azure-resources-using-arm-template).
139-
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 the steps below for each Azure Service Bus namespace that you want to monitor.
140-
* Choose `Stream to an event hub` as the destination.
141-
* Select `AllMetrics`.
142-
* 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 the 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" />
143-
* Tag the location and entityname fields in the source with the 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" />
14437

14538
### Configure logs collection
14639

@@ -167,15 +60,27 @@ Since this source contains logs from multiple regions, make sure that you do not
16760

16861
Now that you have set up data collection, install the Azure Service Bus Sumo Logic app to use the pre-configured [dashboards](#viewing-the-azure-service-bus-dashboards) that provide visibility into your environment for real-time analysis of overall usage.
16962

170-
import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2.md';
63+
import AppInstallIndexV2 from '../../reuse/apps/app-install-index-option.md';
64+
65+
<AppInstallIndexV2/>
66+
67+
As part of the app installation process, the following fields will be created by default:
17168

172-
<AppInstallNoDataSourceV2/>
69+
- `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).
70+
- `location`. The region the resource name belongs to.
71+
- `subscription_id`. ID associated with a subscription where the resource is present.
72+
- `resource_group`. The resource group name where the Azure resource is present.
73+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
74+
- `resource_type`. Azure resource type (for example, storage accounts).
75+
- `resource_name`. The name of the resource (for example, storage account name).
76+
- `service_type`. The type of service that can be accessed with an Azure resource.
77+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances, the service is Subscriptions).
17378

17479
## Viewing the Azure Service Bus dashboards
17580

176-
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
81+
import ViewDashboardsIndex from '../../reuse/apps/view-dashboards-index.md';
17782

178-
<ViewDashboards/>
83+
<ViewDashboardsIndex/>
17984

18085
### Overview
18186

@@ -241,6 +146,23 @@ Use this dashboard to:
241146

242147
<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" />
243148

149+
## Create monitors for Azure Service Bus App
150+
151+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
152+
153+
<CreateMonitors/>
154+
155+
### Azure Service Bus Alerts
156+
157+
These alerts are metrics-based and will work for all Azure Service Bus.
158+
159+
| Name | Description | Alert Condition | Recover Condition |
160+
|:--|:--|:--|:--|
161+
| `Azure Service Bus - High Count of Active Messages` | This alert is triggered when active message count greater than 5000. Also, a warning type alert will be triggered when active message count greater than 1000. | Count > 5000 | Count < = 5000 |
162+
| `Azure Service Bus - High Count of Dead-lettered Messages` | This alert is triggered when dead- lettered message count greater than 50. Also, a warning type alert will be triggered when dead- lettered message count greater than 10. | Count > 50 | Count < = 50 |
163+
| `Azure Service Bus - High Count of Messages (Overall)` | This alert is triggered when messages count (active, dead-lettered, scheduled, etc.) greater than 6000. Also, a warning type alert will be triggered when messages count greater than 1500. | Count > 6000 | Count < = 6000 |
164+
| `Azure Service Bus - High Size Consumption` | This alert is triggered when average size is greater than 3000000000 bytes. Also, a warning type alert will be triggered when average size is greater than 1073741824 bytes. | Count > 3000000000 | Count < = 3000000000 |
165+
244166
## Upgrade/Downgrade the Azure Service Bus app (optional)
245167

246168
import AppUpdate from '../../reuse/apps/app-update.md';

0 commit comments

Comments
 (0)