Skip to content

Commit 6d1f236

Browse files
amee-sumoApoorvkudesia-sumologicsachin-sumologic
authored
Update Azure SQL with Azure metrics source compatibility (#5446)
* Update sql.md * SUMO-261999 | Apoorv | Add. monitor alerts * SUMO-261999 | Apoorv | Add. more monitors * Update sql.md * SUMO-261999 | Apoorv | Add. auto tuning note in the configure logs section * updated auto tuning logs collection note * SUMO-261999 | Apoorv | add metric collection note to doc --------- Co-authored-by: Apoorv Kudesia <[email protected]> Co-authored-by: Sachin Magar <[email protected]>
1 parent a2c5f1d commit 6d1f236

File tree

1 file changed

+46
-97
lines changed
  • docs/integrations/microsoft-azure

1 file changed

+46
-97
lines changed

docs/integrations/microsoft-azure/sql.md

Lines changed: 46 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -92,106 +92,17 @@ Azure service sends monitoring data to Azure Monitor, which can then [stream dat
9292

9393
* 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/).
9494
* Activity 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/). It is recommended to create a separate source for activity logs. If you are already collecting these logs, you can skip this step.
95-
* 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.
95+
* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
9696

9797
You must explicitly enable diagnostic settings for each Azure SQL database that 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).
9898

9999
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/SQL/Logs`, `Azure/SQL/ActivityLogs`, and `Azure/SQL/Metrics`.
100100

101-
### Configure field in field schema
102-
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**.
103-
2. Search for following fields:
104-
- `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).
105-
- `location`. The region to which the resource name belongs to.
106-
- `subscription_id`. Id associated with a subscription where resource is present.
107-
- `resource_group`. The resource group name where the Azure resource is present.
108-
- `provider_name`. Azure resource provider name (for example, Microsoft.SQL).
109-
- `resource_type`. Azure resource type (for example, SERVERS).
110-
- `resource_name`. The name of the resource (for example, Azure SQL Server name).
111-
- `service_type`. Type of the service that can be accessed from with a azure resource (for example, DATABASES).
112-
- `service_name`. Services that can be accessed from within an Azure resource (for example, Azure SQL database name in Azure SQL Server).
113-
114-
3. Create the fields if it is not present. Refer to [create and manage fields](/docs/manage/fields/#manage-fields).
115-
116-
### Configure Field Extraction Rules
117-
118-
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.
119-
120-
* **Azure Location Extraction FER**
121-
122-
```sql
123-
Rule Name: AzureLocationExtractionFER
124-
Applied at: Ingest Time
125-
Scope (Specific Data): tenant_name=*
126-
```
127-
128-
```sql title="Parse Expression"
129-
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
130-
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
131-
| if (!isBlank(resourceLocation), resourceLocation, location) as location
132-
| if (!isBlank(service_region), service_region, location) as location
133-
| if (isBlank(location), "global", location) as location
134-
| fields location
135-
```
136-
137-
* **Resource ID Extraction FER**
138-
139-
```sql
140-
Rule Name: AzureResourceIdExtractionFER
141-
Applied at: Ingest Time
142-
Scope (Specific Data): tenant_name=*
143-
```
144-
145-
```sql title="Parse Expression"
146-
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
147-
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
148-
| toUpperCase(resourceId) as resourceId
149-
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
150-
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
151-
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
152-
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
153-
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
154-
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
155-
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
156-
```
157-
### Configure metric rules
158-
159-
* **Azure Observability Metadata Extraction Service Level**
160-
161-
If this rule already exists, there's no need to create it again.
162-
163-
```sql
164-
Rule Name: AzureObservabilityMetadataExtractionServiceLevel
165-
```
166-
167-
```sql title="Metric match expression"
168-
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/*/*/*/* tenant_name=*
169-
```
170-
| Fields extracted | Metric rule |
171-
|:------------------|:----------------|
172-
| subscription_id | $resourceId._1 |
173-
| resource_group | $resourceId._2 |
174-
| provider_name | $resourceId._3 |
175-
| resource_type | $resourceId._4 |
176-
| resource_name | $resourceId._5 |
177-
| service_type | $resourceId._6 |
178-
| service_name | $resourceId._7 |
179-
180-
181101
### Configure metrics collection
182102

183-
In this section, you will configure a pipeline to send metrics from Azure Monitor to an Event Hub, then to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
103+
import MetricsSourceBeta from '../../reuse/metrics-source-beta.md';
184104

185-
1. Create hosted collector and tag `tenant_name` field.<br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Tenant-Name.png')} alt="Azure Database for MySql Tag Tenant Name" style={{border: '1px solid gray'}} width="800" />
186-
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).
187-
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).
188-
4. [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 below steps for each Azure SQL database that you want to monitor.
189-
* Choose `Stream to an event hub` as destination.
190-
* Select all the metric types under `Metrics` section.
191-
* 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.
192-
![diagnosticsetting.png](/img/send-data/azuresqldatabasediagnosticsetting.png)
193-
194-
5. 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 Database for MySql Tag Location" style={{border: '1px solid gray'}} width="400" />
105+
<MetricsSourceBeta/>
195106

196107
### Configure logs collection
197108

@@ -210,6 +121,9 @@ In this section, you will configure a pipeline for shipping diagnostic logs from
210121

211122
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 Database for MySql Tag Location" style={{border: '1px solid gray'}} width="400" />
212123

124+
:::note
125+
Auto Tuning logs will be collected when Auto Tuning feature is enabled in Azure SQL. Click [here](https://learn.microsoft.com/en-us/azure/azure-sql/database/automatic-tuning-enable?view=azuresql) to learn more on how to enable this feature.
126+
:::
213127
#### Enable SQL Security Audit logs
214128
In this section, you will configure a pipeline for shipping diagnostic logs from [Azure Monitor](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-get-started) to an Event Hub.
215129

@@ -254,15 +168,27 @@ In **Defender Plans** settings page turn on the **Databases** status under **Clo
254168

255169
This section provides instructions on how to install the Azure SQL app, and shows examples of each of the preconfigured dashboards you can use to analyze your data.
256170

257-
import AppInstall2 from '../../reuse/apps/app-install-v2.md';
171+
import AppInstallIndexV2 from '../../reuse/apps/app-install-index-option.md';
172+
173+
<AppInstallIndexV2/>
174+
175+
As part of the app installation process, the following fields will be created by default:
258176

259-
<AppInstall2/>
177+
- `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).
178+
- `location`. The region the resource name belongs to.
179+
- `subscription_id`. ID associated with a subscription where the resource is present.
180+
- `resource_group`. The resource group name where the Azure resource is present.
181+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
182+
- `resource_type`. Azure resource type (for example, storage accounts).
183+
- `resource_name`. The name of the resource (for example, storage account name).
184+
- `service_type`. Type of the service that can be accessed with an Azure resource.
185+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
260186

261187
## Viewing the Azure SQL dashboards
262188

263-
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
189+
import ViewDashboardsIndex from '../../reuse/apps/view-dashboards-index.md';
264190

265-
<ViewDashboards/>
191+
<ViewDashboardsIndex/>
266192

267193
### Overview
268194

@@ -573,4 +499,27 @@ import AppUpdate from '../../reuse/apps/app-update.md';
573499

574500
import AppUninstall from '../../reuse/apps/app-uninstall.md';
575501

576-
<AppUninstall/>
502+
<AppUninstall/>
503+
504+
## Create monitors for Azure SQL
505+
506+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
507+
508+
<CreateMonitors/>
509+
510+
### Azure SQL alerts
511+
512+
These alerts are metrics-based and will work for Azure SQL.
513+
514+
| Alert Name | Description | Alert Condition | Recover Condition |
515+
|:--|:--|:--|:--|
516+
| `Azure SQL - Availability` | This monitor triggers alerts when Availability drops below 100% in Azure SQL. | Count < 100 | Count >= 100 |
517+
| `Azure SQL - Data space used percent` | This monitor triggers alerts when High Data space used percent is detected in Azure SQL. | Count > 80 | Count =< 80 |
518+
| `Azure SQL - Deadlocks` | This monitor triggers alerts when deadlock is detected in Azure SQL. | Count > 1 | Count =< 1 |
519+
| `Azure SQL - Failed Connections` | This monitor triggers alerts when Failed Connections are detected in Azure SQL. | Count > 1 | Count =< 1 |
520+
| `Azure SQL - High Cpu Usage` | This monitor triggers alerts when high CPU usage is detected in Azure SQL. | Count >= 90 | Count < 90 |
521+
| `Azure SQL - High SQL instance CPU Usage` | This monitor triggers alerts when High Instance CPU usage is detected in Azure SQL. | Count >= 90 | Count < 90 |
522+
| `Azure SQL - Data IO percentage` | This monitor triggers alerts when High Data IO percentage is detected in Azure SQL. | Count > 90 | Count =< 90 |
523+
| `Azure SQL - DTU Percentage` | This monitor triggers alerts when High average DTU consumption percentage is detected in Azure SQL. | Count > 80 | Count =< 80 |
524+
| `Azure SQL - Tempdb Percent Log Used` | This monitor triggers alerts when High Tempdb Percent Log Usage is detected in Azure SQL. | Count > 60 | Count =< 60 |
525+
| `Azure SQL - High Worker Usage` | This monitor triggers alerts when High Worker Usage is detected in Azure SQL. | Count > 60 | Count =< 60 |

0 commit comments

Comments
 (0)