Skip to content

Commit 105d6a3

Browse files
Update Azure docs for Azure metrics source compatibility (Apps - Part 1) (#5354)
* Update Azure docs * Update kubernetes.md --------- Co-authored-by: Himanshu Pal <[email protected]>
1 parent 7846f1d commit 105d6a3

File tree

3 files changed

+51
-186
lines changed

3 files changed

+51
-186
lines changed

docs/integrations/microsoft-azure/azure-application-gateway.md

Lines changed: 25 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -34,103 +34,15 @@ This app supports only Application Gateway V2 since Application Gateway V1 will
3434
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:
3535

3636
* 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/).
37-
* 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.
37+
* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
3838

3939
You must explicitly enable diagnostic settings for each Azure Application Gateway 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).
4040

4141
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/ApplicationGateway/Logs`, `Azure/ApplicationGateway/Metrics`.
4242

43-
44-
### Configure field in field schema
45-
46-
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**.
47-
1. Search for the following fields:
48-
- `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).
49-
- `location`. The region to which the resource name belongs to.
50-
- `subscription_id`. ID associated with a subscription where the resource is present.
51-
- `resource_group`. The resource group name where the Azure resource is present.
52-
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
53-
- `resource_type`. Azure resource type (for example, storage accounts).
54-
- `resource_name`. The name of the resource (for example, storage account name).
55-
- `service_type`. Type of the service that can be accessed with a Azure resource.
56-
- `service_name`. Services that can be accessed with an Azure resource (for example, Azure SQL databases in Azure SQL Server).
57-
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
58-
59-
### Configure Field Extraction Rules
60-
61-
Create the following field extraction rules (FER) for Azure Storage by following the instructions in [Create a Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule/).
62-
63-
#### Azure location extraction FER
64-
65-
```sql
66-
Rule Name: AzureLocationExtractionFER
67-
Applied at: Ingest Time
68-
Scope (Specific Data): tenant_name=*
69-
```
70-
71-
```sql title="Parse Expression"
72-
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
73-
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
74-
| if (!isBlank(resourceLocation), resourceLocation, location) as location
75-
| if (!isBlank(service_region), service_region, location) as location
76-
| if (isBlank(location), "global", location) as location
77-
| fields location
78-
```
79-
80-
#### Resource ID extraction FER
81-
82-
```sql
83-
Rule Name: AzureResourceIdExtractionFER
84-
Applied at: Ingest Time
85-
Scope (Specific Data): tenant_name=*
86-
```
87-
88-
```sql title="Parse Expression"
89-
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
90-
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
91-
| toUpperCase(resourceId) as resourceId
92-
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
93-
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
94-
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
95-
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
96-
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
97-
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
98-
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
99-
```
100-
101-
### Configure metric rules
102-
103-
Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule).
104-
105-
#### Azure observability metadata extraction application gateway level
106-
107-
```sql
108-
Rule Name: AzureObservabilityMetadataExtractionAppGatewayLevel
109-
```
110-
111-
```sql title="Metric match expression"
112-
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/APPLICATIONGATEWAYS/* tenant_name=*
113-
```
114-
| Fields extracted | Metric rule |
115-
|:------------------|:---------------------|
116-
| subscription_id | $resourceId._1 |
117-
| resource_group | $resourceId._2 |
118-
| provider_name | $resourceId._3 |
119-
| resource_type | APPLICATIONGATEWAYS |
120-
| resource_name | $resourceId._4 |
121-
12243
### Configure metrics collection
12344

124-
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.
125-
126-
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" />
127-
2. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
128-
3. [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).
129-
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 Application Gateway that you want to monitor.
130-
1. Choose `Stream to an event hub` as destination.
131-
1. Select `AllMetrics`.
132-
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/azureapplicationgateway-metrics.png')} alt="Azure application gateway metrics" style={{border: '1px solid gray'}} width="800" />
133-
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 Application Gateway Tag Location" style={{border: '1px solid gray'}} width="400" />
45+
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).
13446

13547
### Configure logs collection
13648

@@ -167,6 +79,18 @@ import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2
16779

16880
<AppInstallNoDataSourceV2/>
16981

82+
As part of the app installation process, the following fields will be created by default:
83+
84+
- `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).
85+
- `location`. The region to which the resource name belongs to.
86+
- `subscription_id`. ID associated with a subscription where the resource is present.
87+
- `resource_group`. The resource group name where the Azure resource is present.
88+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
89+
- `resource_type`. Azure resource type (for example, storage accounts).
90+
- `resource_name`. The name of the resource (for example, storage account name).
91+
- `service_type`. Type of the service that can be accessed with a Azure resource.
92+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
93+
17094
## Viewing the Azure Application Gateway dashboards
17195

17296
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
@@ -244,6 +168,17 @@ import AppUninstall from '../../reuse/apps/app-uninstall.md';
244168

245169
<AppUninstall/>
246170

171+
### Azure Application Gateway alerts
172+
These alerts are metric based and will work for all Azure Application Gateways.
173+
174+
| Alert Name | Alert Description and Conditions | Alert Condition | Recover Condition |
175+
|:-----------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:------------------|
176+
| `Azure Application Gateway - Current Capacity Units` | This alert is triggered when Average Capacity Units count is greater than 75. Also, a warning type alert will be triggered when Average Capacity Units count is greater than 65. | percentage >= 75 | percentage < 75 |
177+
| `Azure Application Gateway - Current Compute Units` | This alert is triggered when Average Compute Units count is greater than 75. Also, a warning type alert will be triggered when Average Compute Units count is greater than 65. | percentage >= 75 | percentage < 75 |
178+
| `Azure Application Gateway - Failed Requests` | This alert is triggered when Failed Requests count greater than 1. | Count >= 1 | Count < 1 |
179+
| `Azure Application Gateway - Healthy Host Count` | This alert is triggered when Healthy Host Count is less than 1. | Count < 1 | Count >= 1 |
180+
| `Azure Application Gateway - UnHealthy Host Count` | This alert is triggered when UnHealthy Host Count is greater than 1 | Count >= 1 | Count < 1 |
181+
247182
## Troubleshooting
248183

249184
### HTTP Logs and Metrics Source used by Azure Functions

0 commit comments

Comments
 (0)