Skip to content

Commit 6baf1d9

Browse files
ankurch627himanshu219JV0812
authored
Doc changes Azure ASE (#4805)
* updated doc for ASE * resolved PR comments * resolved PR comments - added diagnostic settings screenshot * resolved pr comments * resolved pr comments * resolved pr comments * Delete docs/integrations/microsoft-azure/test.json * Minor fix --------- Co-authored-by: Himanshu Pal <[email protected]> Co-authored-by: Jagadisha V <[email protected]>
1 parent 90ae7fd commit 6baf1d9

File tree

2 files changed

+127
-8
lines changed

2 files changed

+127
-8
lines changed

docs/integrations/microsoft-azure/azure-app-service-environment.md

Lines changed: 127 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,144 @@ The below instructions applies to App Service Environment v3.
1616

1717
For Azure App Service Environment, you can collect the following logs:
1818

19-
* **App Service Environment Platform Logs**. Logs are only emitted when your App Service Environment has an event (for example, a scale operation with an App Service plan) that triggers the logs. To learn more about the different situations and messages collected for Azure App Service Environment, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/app-service/environment/using#logging).
19+
* **Activity logs**, provides insight into any subscription-level or management group level events that have occurred in the Azure. To learn more, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/activity-log-schema).
2020

21-
## Setup
21+
* **App Service Environment Platform Logs**. Logs are only emitted when your App Service Environment has an event (for example, a scale operation with an App Service Environment) that triggers the logs. To learn more about the different situations and messages collected for Azure App Service Environment, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/app-service/environment/using#logging).
2222

23-
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:
23+
## Setup
2424

25-
* 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/).
25+
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 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/).
2626

2727
You must explicitly enable diagnostic settings for each Azure App Service Environment 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).
2828

2929
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/AppServiceEnvironment/Logs`, `Azure/AppServiceEnvironment/Metrics`.
3030

31+
### Configure field in field schema
32+
33+
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**.
34+
1. Search for following fields:
35+
- `tenant_name`. This field is tagged at the collector level and 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).
36+
- `location`. The region to which the resource name belongs to.
37+
- `subscription_id`. ID associated with a subscription where resource is present.
38+
- `resource_group`. The resource group name where the Azure resource is present.
39+
- `provider_name`. Azure resource provider name (for example, Microsoft.WEB).
40+
- `resource_type`. Azure resource type (for example, SITES).
41+
- `resource_name`. The name of the resource (for example, Azure Function App name).
42+
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
43+
44+
### Configure Field Extraction Rules
45+
46+
Create a Field Extraction Rule (FER) by following the instructions [here](/docs/manage/field-extractions/create-field-extraction-rule/). If the FER already exists with same name, then skip this step.
47+
48+
#### Azure location extraction FER
49+
50+
```sql
51+
Rule Name: AzureLocationExtractionFER
52+
Applied at: Ingest Time
53+
Scope (Specific Data): tenant_name=*
54+
```
55+
56+
```sql title="Parse Expression"
57+
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
58+
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
59+
| if (!isBlank(resourceLocation), resourceLocation, location) as location
60+
| if (!isBlank(service_region), service_region, location) as location
61+
| if (isBlank(location), "global", location) as location
62+
| fields location
63+
```
64+
65+
#### Resource ID extraction FER
66+
67+
```sql
68+
Rule Name: AzureResourceIdExtractionFER
69+
Applied at: Ingest Time
70+
Scope (Specific Data): tenant_name=*
71+
```
72+
73+
```sql title="Parse Expression"
74+
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
75+
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
76+
| toUpperCase(resourceId) as resourceId
77+
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
78+
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
79+
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
80+
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
81+
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
82+
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
83+
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
84+
```
85+
3186
### Configure logs collection
3287

88+
#### Diagnostic logs
89+
3390
In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.
3491

3592
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/).
36-
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 App Service Environment that you want to monitor.
37-
* Choose `Stream to an event hub` as the destination.
38-
* Select `App Service Environment Platform Logs`.
39-
* 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.
93+
2. To create the **Diagnostic setting** in the Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/data-factory/monitor-configure-diagnostics). Perform the below steps for each Azure App Service Environment that you want to monitor.
94+
1. Choose `Stream to an event hub` as the destination.
95+
1. Select `App Service Environment Platform Logs`.
96+
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.
97+
<img src={useBaseUrl('img/send-data/Azure-App-Service-Plan-Configure-Diagnostic-Logs.png')} alt="Azure App Service Environment logs" style={{border: '1px solid gray'}} width="800" />
98+
3. 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 App Service Environment Tag Location" style={{border: '1px solid gray'}} width="400" />
99+
100+
#### Activity logs (optional)
101+
102+
To collect activity logs, follow the instructions [here](/docs/integrations/microsoft-azure/audit). If you are already collecting activity logs for a subscription, do not perform this step.
103+
104+
## Installing the Azure App Service Environment app
105+
106+
This section provides instructions on how to install the Azure App Service Environment app, and shows examples of each of the preconfigured dashboards you can use to analyze your data.
107+
108+
import AppInstall2 from '../../reuse/apps/app-install-v2.md';
109+
110+
<AppInstall2/>
111+
112+
## Viewing Azure App Service Environment dashboards
113+
114+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
115+
116+
<ViewDashboards/>
117+
118+
### Overview
119+
120+
The **Azure App Service Environment - Overview** dashboard provides comprehensive information of all the service health incidents or resource health events associated with Azure App Service Environments in your azure account.
121+
122+
Use this dashboard to:
123+
* View recent resource and service health incidents.
124+
* View distribution of service and resource health by incident type.
125+
126+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-AppServiceEnvironment/Azure-App-Service-Environment-Overview.png')} alt="Azure AppServiceEnvironment Overview dashboard" style={{border: '1px solid gray'}} width="800" />
127+
128+
### Operations
129+
130+
The **Azure App Service Environment - Operations** dashboard offers comprehensive insights into the scaling, upgrade events for your Azure App Service Environment.
131+
132+
Use this dashboard to:
133+
* Analyze scaling and upgrade events for your App Service Environment
134+
* Identify potential operations issues affecting your app service environment.
135+
136+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-AppServiceEnvironment/Azure-App-Service-Environment-Operations.png')} alt="Azure AppServiceEnvironment Operations dashboard" style={{border: '1px solid gray'}} width="800" />
137+
138+
### Administrative Operations
139+
140+
The **Azure App Service Environment - Administrative Operations** dashboard provides details on read/write/delete specific changes, different operations used, top 10 operations that caused most errors, and users performing admin operations.
141+
142+
Use this dashboard to:
143+
* Identify top users performing administrative operations.
144+
* View Top 10 operations that caused the most errors.
145+
* View recent read, write, and delete operations.
146+
147+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-AppServiceEnvironment/Azure-App-Service-Environment-Administrative-Operations.png')} alt="Azure AppServiceEnvironment Administrative Operations dashboard" style={{border: '1px solid gray'}} width="800" />
148+
149+
## Upgrading the Azure App Service Environment app (Optional)
150+
151+
import AppUpdate from '../../reuse/apps/app-update.md';
152+
153+
<AppUpdate/>
154+
155+
## Uninstalling the Azure App Service Environment app (Optional)
156+
157+
import AppUninstall from '../../reuse/apps/app-uninstall.md';
40158

159+
<AppUninstall/>
276 KB
Loading

0 commit comments

Comments
 (0)