Skip to content

Commit dd6db08

Browse files
Apoorvkudesia-sumologickimsauceamee-sumo
authored
SUMO-259572 | Apoorv | Add. function app doc updates (#5364)
* SUMO-259572 | Apoorv | Add. function app doc updates * Update docs/integrations/microsoft-azure/azure-functions.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * Update docs/integrations/microsoft-azure/azure-functions.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * Update azure-virtual-machine.md * SUMO-259572 | Apoorv | Add. Metric rules section back in VM doc * SUMO-259572 | Apoorv | Fix. uninstall section --------- Co-authored-by: Kim (Sumo Logic) <[email protected]> Co-authored-by: Amee Lepcha <[email protected]>
1 parent 037dcb0 commit dd6db08

File tree

2 files changed

+64
-117
lines changed

2 files changed

+64
-117
lines changed

docs/integrations/microsoft-azure/azure-functions.md

Lines changed: 46 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ To learn more about configuring monitoring for Azure functions, refer to the [Az
2222

2323
* **Activity logs**. Provides insight into any subscription-level or management group level events that have occurred in Azure. To learn more, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/activity-log-schema).
2424

25-
* **Azure Functions specific metrics**. These are metrics specific to Functions like execution count and execution units.
26-
For more information on supported metrics, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-functions/monitor-functions-reference#azure-functions-specific-metrics).
25+
* **Azure Functions specific metrics**. These are metrics specific to Functions like execution count and execution units. For more information on supported metrics, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-functions/monitor-functions-reference#azure-functions-specific-metrics).
2726
* **General App Service metrics**. Metrics which App Service platform implements. These metrics are available in the `Microsoft.Web/sites` namespace. For more information on supported metrics, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/app-service/web-sites-monitor#understand-metrics).
2827

2928
### Sample queries
@@ -37,102 +36,15 @@ tenant_name=* subscription_id=* location=* resource_group=* provider_name=micros
3736
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:
3837

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

4241
You must explicitly enable diagnostic settings for each Azure Functions you want to monitor. Diagnostic Settings are not supported for function apps running on version 1.x. 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).
4342

4443
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/FunctionApp/Logs`, `Azure/FunctionApp/Metrics`.
4544

46-
### Configure field in field schema
47-
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**.
48-
1. Search for the following fields:
49-
- `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).
50-
- `location`. The region to which the resource name belongs.
51-
- `subscription_id`. ID associated with a subscription where the resource is present.
52-
- `resource_group`. The resource group name where the Azure resource is present.
53-
- `provider_name`. Azure resource provider name (for example, Microsoft.WEB).
54-
- `resource_type`. Azure resource type (for example, SITES).
55-
- `resource_name`. The name of the resource (for example, Azure Function App name).
56-
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
57-
58-
### Configure Field Extraction Rules
59-
60-
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 the same name, then skip this step.
61-
62-
#### Azure Location Extraction FER
63-
64-
```sql
65-
Rule Name: AzureLocationExtractionFER
66-
Applied at: Ingest Time
67-
Scope (Specific Data): tenant_name=*
68-
```
69-
70-
```sql title="Parse Expression"
71-
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
72-
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
73-
| if (!isBlank(resourceLocation), resourceLocation, location) as location
74-
| if (!isBlank(service_region), service_region, location) as location
75-
| if (isBlank(location), "global", location) as location
76-
| fields location
77-
```
78-
79-
#### Resource ID Extraction FER
80-
81-
```sql
82-
Rule Name: AzureResourceIdExtractionFER
83-
Applied at: Ingest Time
84-
Scope (Specific Data): tenant_name=*
85-
```
86-
87-
```sql title="Parse Expression"
88-
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
89-
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
90-
| toUpperCase(resourceId) as resourceId
91-
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
92-
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
93-
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
94-
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
95-
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
96-
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
97-
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
98-
```
99-
100-
101-
### Configure metric rules
102-
103-
#### Azure Observability Metadata Extraction Service Level
104-
105-
If this rule already exists, there's no need to create it again.
106-
107-
```sql
108-
Rule Name: AzureObservabilityMetadataExtractionAppServiceLevel
109-
```
110-
111-
```sql title="Metric match expression"
112-
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/SITES/* tenant_name=*
113-
```
114-
115-
| Fields extracted | Metric rule |
116-
|:-----------------|:---------------|
117-
| `subscription_id` | $resourceId._1 |
118-
| `resource_group` | $resourceId._2 |
119-
| `provider_name` | $resourceId._3 |
120-
| `resource_type` | SITES |
121-
| `resource_name` | $resourceId._4 |
122-
123-
12445
### Configure metrics collection
12546

126-
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.
127-
128-
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" />
129-
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).
130-
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).
131-
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 Functions that you want to monitor.
132-
1. Choose `Stream to an event hub` as the destination.
133-
1. Select `AllMetrics`.
134-
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 the ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.
135-
4. Tag the location field in the source with the right location value.<br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Functions app Tag Location" style={{border: '1px solid gray'}} width="400" />
47+
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).
13648

13749
### Configure logs collection
13850

@@ -177,6 +89,18 @@ import AppInstall2 from '../../reuse/apps/app-install-v2.md';
17789

17890
<AppInstall2/>
17991

92+
As part of the app installation process, the following fields will be created by default:
93+
94+
- `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).
95+
- `location`. The region to which the resource name belongs to.
96+
- `subscription_id`. ID associated with a subscription where the resource is present.
97+
- `resource_group`. The resource group name where the Azure resource is present.
98+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
99+
- `resource_type`. Azure resource type (for example, storage accounts).
100+
- `resource_name`. The name of the resource (for example, storage account name).
101+
- `service_type`. Type of the service that can be accessed with a Azure resource.
102+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
103+
180104
## Viewing the Azure Functions dashboards
181105

182106
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
@@ -295,7 +219,7 @@ Use this dashboard to:
295219

296220
### Administrative Operations
297221

298-
The **Azure SQL - Administrative Operations** dashboard provides details on read/write/delete specific changes, different operations used, the top 10 operations that caused the most errors, and users performing admin operations.
222+
The **Azure Functions - Administrative Operations** dashboard provides details on read/write/delete specific changes, different operations used, the top 10 operations that caused the most errors, and users performing admin operations.
299223

300224
Use this dashboard to:
301225
* Identify top users performing administrative operations.
@@ -304,6 +228,36 @@ Use this dashboard to:
304228

305229
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Functions/Azure-Functions-Administrative-Operations.png')} alt="Azure Functions Administrative Operations dashboard" style={{border: '1px solid gray'}} width="800" />
306230

231+
### Instances
232+
233+
The **Azure Functions - Instances** dashboard provides information of all effect action details performed based on Azure Functions Instances.
234+
235+
Use this dashboard to:
236+
* View recent resource usage and performance based on Instances.
237+
* View distribution and service usage of resources by Instance.
238+
239+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Functions/Azure-Functions-Instance.png')} alt="Azure Functions Instances dashboard" style={{border: '1px solid gray'}} width="800" />
240+
241+
242+
## Create monitors for Azure Functions app
243+
244+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
245+
246+
<CreateMonitors/>
247+
248+
### Azure Functions alerts
249+
250+
These alerts are metrics-based and will work for all Functions.
251+
252+
| Alert Name | Description | Alert Condition | Recover Condition |
253+
|:------------------------------------------|:-------------------------------------------------------------------------------------------|:----------------|:------------------|
254+
| `Azure Functions - Average Response Time` | This alert gets triggered when there is high response time detected in any Azure Function. | Count < 1 | Count >= 1 |
255+
| `Azure Functions - Delete function app` | This alert gets triggered when a function app is deleted. | Count >= 1 | Count < 1 |
256+
| `Azure Functions - Health Check Status` | This alert gets triggered when there is Health Check Status average drops less than 100. | Count < 100 | Count >= 100 |
257+
| `Azure Functions - Http 4xx Error` | This alert gets triggered when HTTP 4xx errors are high in the Azure Functions. | Count > 25 | Count =< 25 |
258+
| `Azure Functions - Https Server Error` | This alert gets triggered when HTTP 5xx errors are high in the Azure Functions. | Count > 25 | Count =< 25 |
259+
260+
307261
## Upgrade/Downgrade the Azure Functions app (Optional)
308262

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

docs/integrations/microsoft-azure/azure-virtual-machine.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,12 @@ For Azure Virtual Machine, 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 [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
2728

2829
You must explicitly enable diagnostic settings for each Virtual Machine 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).
2930

3031
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/VM/ActivityLogs`, `Azure/VM/Metrics`.
3132

32-
### Configure field in field schema
33-
34-
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**.
35-
1. Search for the following fields:
36-
- `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).
37-
- `location`. The region to which the resource name belongs to.
38-
- `subscription_id`. ID associated with a subscription where the resource is present.
39-
- `resource_group`. The resource group name where the Azure resource is present.
40-
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
41-
- `resource_type`. Azure resource type (for example, storage accounts).
42-
- `resource_name`. The name of the resource (for example, storage account name).
43-
- `service_type`. Type of the service that can be accessed with a Azure resource.
44-
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances service is Subscriptions).
45-
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
46-
4733
### Configure metric rules
4834

4935
* **Azure Observability Metadata Extraction VMName**
@@ -61,16 +47,9 @@ tenant_name=* namespace=Microsoft.Compute/virtualMachines resource_name=*
6147
| Fields extracted | Metric rule |
6248
|:--|:--|
6349
| `vmname` | `$resource_name._1` |
64-
6550
### Configure metrics collection
6651

67-
:::note
68-
The Sumo Logic metrics source for Azure is currently in Beta. To participate, contact your Sumo Logic account executive.
69-
:::
70-
71-
1. To set up the Azure Metrics source in Sumo Logic, refer to the shared beta documentation.
72-
1. In the Sumo Logic Azure Metrics source configuration, configure namespaces as `Microsoft.Compute/virtualMachines` and `Microsoft.Compute/virtualMachineScaleSets`.
73-
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-virtual-machine-namespaces.png')} alt="Azure Virtual Machine Namespaces" style={{border: '1px solid gray'}} width="500" />
52+
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).
7453

7554
### Configure logs collection
7655

@@ -99,6 +78,18 @@ import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2
9978

10079
<AppInstallNoDataSourceV2/>
10180

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

10495
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
@@ -186,12 +177,14 @@ These alerts are metric based and will work for all Virtual Machine.
186177
| `Azure Virtual Machine - Data Disk IOPs Consumed Monitor` | This alert is triggered when Data Disk IOPs consumption percentage spikes above 95% are detected for any VM. | Count > 95 | Count =< 95 |
187178
| `Azure Virtual Machine - OS Disk IOPs Consumed Monitor`| This alert is triggered when OS Disk IOPs consumption percentage spikes above 95% are detected for any VM. | Count > 95 | Count =< 95 |
188179

189-
## Upgrade/Downgrade the Azure Virtual Network app (optional)
180+
## Upgrade/Downgrade the Azure Virtual Machine app (optional)
190181

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

193184
<AppUpdate/>
194185

195-
## Uninstalling the Azure Virtual Network app (optional)
186+
## Uninstalling the Azure Virtual Machine app (optional)
196187

197188
import AppUninstall from '../../reuse/apps/app-uninstall.md';
189+
190+
<AppUninstall/>

0 commit comments

Comments
 (0)