Skip to content

Commit 75c55bb

Browse files
SUMO-259572 | Apoorv | Add. Dashboard updates and Monitors for AzureFunction
1 parent 7846f1d commit 75c55bb

File tree

1 file changed

+45
-91
lines changed

1 file changed

+45
-91
lines changed

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

Lines changed: 45 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To learn more about configuring monitoring for Azure functions, refer to the [Az
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

2525
* **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).
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).
2727
* **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).
2828

2929
### Sample queries
@@ -37,102 +37,15 @@ tenant_name=* subscription_id=* location=* resource_group=* provider_name=micros
3737
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:
3838

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

4242
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).
4343

4444
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`.
4545

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-
12446
### Configure metrics collection
12547

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" />
48+
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).
13649

13750
### Configure logs collection
13851

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

17891
<AppInstall2/>
17992

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

182107
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
@@ -295,7 +220,7 @@ Use this dashboard to:
295220

296221
### Administrative Operations
297222

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.
223+
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.
299224

300225
Use this dashboard to:
301226
* Identify top users performing administrative operations.
@@ -304,6 +229,35 @@ Use this dashboard to:
304229

305230
<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" />
306231

232+
### Instances
233+
234+
The **Azure Functions - Instances** dashboard provides information of all effect action details performed based on Azure Functions Instances.
235+
236+
Use this dashboard to:
237+
* View recent resource usage and performance based on Instances.
238+
* View distribution and service usage of resources by Instance.
239+
240+
<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" />
241+
242+
243+
## Create monitors for Azure Functions app
244+
245+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
246+
247+
<CreateMonitors/>
248+
249+
### Azure Functions alerts
250+
These alerts are metric 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';

0 commit comments

Comments
 (0)