Skip to content

Commit 3bd7190

Browse files
authored
Merge pull request #276372 from cdpark/horz-monitor-synapse
User Story 246543: Q&M: Curate 27 SOX Azure Monitor horizontals articles to reduce duplication - Synapse Analytics
2 parents ea498e6 + 25c9aaa commit 3bd7190

12 files changed

+228
-95
lines changed

articles/synapse-analytics/guidance/implementation-success-perform-monitoring-review.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ Using your solution requirements and other data collected during the [assessment
1919

2020
You can use [Azure Monitor](../../azure-monitor/overview.md) to provide base-level infrastructure metrics, alerts, and logs for most Azure services. Azure diagnostic logs are emitted by a resource to provide rich, frequent data about the operation of that resource. Azure Synapse can write diagnostic logs in Azure Monitor.
2121

22-
For more information, see [Use Azure Monitor with your Azure Synapse Analytics workspace](../monitoring/how-to-monitor-using-azure-monitor.md).
22+
For more information, see [Use Azure Monitor with your Azure Synapse Analytics workspace](../monitor-synapse-analytics.md).
2323

2424
## Monitor dedicated SQL pools
2525

26-
You can monitor a dedicated SQL pool by using Azure Monitor, altering, dynamic management views (DMVs), and Log Analytics.
26+
You can monitor a dedicated SQL pool by using Azure Monitor, alerting, dynamic management views (DMVs), and Log Analytics.
2727

28-
- **Alerts:** You can set up alerts that send you an email or call a webhook when a certain metric reaches a predefined threshold. For example, you can receive an alert email when the database size grows too large. For more information, see [Create alerts for Azure SQL Database and Azure Synapse Analytics using the Azure portal](/azure/azure-sql/database/alerts-insights-configure-portal).
28+
- **Alerts:** You can set up alerts that send you an email or call a webhook when a certain metric reaches a predefined threshold. For example, you can receive an alert email when the database size grows too large. For more information, see [Alerts](../monitor-synapse-analytics.md#alerts).
2929
- **DMVs:** You can use [DMVs](../sql-data-warehouse/sql-data-warehouse-manage-monitor.md) to monitor workloads to help investigate query executions in SQL pools.
3030
- **Log Analytics:** [Log Analytics](../../azure-monitor/logs/log-analytics-tutorial.md) is a tool in the Azure portal that you can use to edit and run log queries from data collected by Azure Monitor. For more information, see [Monitor workload - Azure portal](../sql-data-warehouse/sql-data-warehouse-monitor-workload-portal.md).
3131

articles/synapse-analytics/guidance/implementation-success-perform-operational-readiness-review.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,7 @@ Set and document expectations for monitoring readiness with your business. These
5656

5757
Consider using [Azure Monitor](../../azure-monitor/overview.md) to collect, analyze, and act on telemetry data from your Azure and on-premises environments. Azure Monitor helps you maximize performance and availability of your applications by proactively identify problems in seconds.
5858

59-
List all the important metrics to monitor for each service in your solution along with their acceptable thresholds. For example, the following list includes important metrics to monitor for a dedicated SQL pool:
60-
61-
- `DWULimit`
62-
- `DWUUsed`
63-
- `AdaptiveCacheHitPercent`
64-
- `AdaptiveCacheUsedPercent`
65-
- `LocalTempDBUsedPercent`
66-
- `ActiveQueries`
67-
- `QueuedQueries`
59+
List all the important metrics to monitor for each service in your solution along with their acceptable thresholds. For example, you can [view metrics](../monitor-synapse-analytics-reference.md#supported-metrics-for-microsoftsynapseworkspacessqlpools) to monitor for a dedicated SQL pool.
6860

6961
Consider using [Azure Service Health](https://azure.microsoft.com/features/service-health/) to notify you about Azure service incidents and planned maintenance. That way, you can take action to mitigate downtime. You can set up customizable cloud alerts and use a personalized dashboard to analyze health issues, monitor the impact to your cloud resources, get guidance and support, and share details and updates.
7062

@@ -74,7 +66,7 @@ Lastly, ensure proper notifications are set up to notify appropriate people when
7466

7567
Define and document *recovery time objective (RTO)* and *recovery point objective (RPO)* for your solution. RTO is how soon the service will be available to users, and RPO is how much data loss would occur in the event of a failover.
7668

77-
Each of the Azure services publishes a set of guidelines and metrics on the expected high availability (HA) of the service. Ensure these HA metrics align with your business expectations. when they don't align, customizations may be necessary to meet your HA requirements. For example, Azure Synapse dedicated SQL pool supports an eight-hour RPO with automatic restore points. If that RPO isn't sufficient, you can set up user-defined restore points with an appropriate frequency to meet your RPO needs. For more information, see [Backup and restore in Azure Synapse dedicated SQL pool](../sql-data-warehouse/backup-and-restore.md).
69+
Each of the Azure services publishes a set of guidelines and metrics on the expected high availability (HA) of the service. Ensure these HA metrics align with your business expectations. When they don't align, customizations may be necessary to meet your HA requirements. For example, Azure Synapse dedicated SQL pool supports an eight-hour RPO with automatic restore points. If that RPO isn't sufficient, you can set up user-defined restore points with an appropriate frequency to meet your RPO needs. For more information, see [Backup and restore in Azure Synapse dedicated SQL pool](../sql-data-warehouse/backup-and-restore.md).
7870

7971
### Disaster recovery
8072

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Learn about monitoring
3+
description: Learn how to monitor Azure Synapse Analytics using Azure Monitor.
4+
ms.date: 03/25/2024
5+
ms.topic: conceptual
6+
author: jonburchel
7+
ms.author: jburchel
8+
ms.service: synapse-analytics
9+
---
10+
11+
# Learn about monitoring
12+
13+
To learn about using Azure Monitor with Azure Synapse Analytics, see [Monitor Synapse Analytics](monitor-synapse-analytics.md). For general details on monitoring Azure resources, see [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource).
14+
15+
For a reference of the Azure Monitor metrics, logs, and other important values created for Synapse Analytics, see [Synapse Analytics monitoring data reference](monitor-synapse-analytics-reference.md).
16+
17+
For a comparison of Log Analytics, Query Store, DMVs, and Azure Data Explorer analytics, see [Historical query storage and analysis in Azure Synapse Analytics](sql/query-history-storage-analysis.md).
18+
19+
For information about monitoring in Synapse Studio, see [Monitor your Synapse Workspace](get-started-monitor.md).
20+
[Tutorial: Monitor your Synapse Workspace](get-started-monitor.md).
21+
22+
For monitoring pipeline runs, see [Monitor pipeline runs in Synapse Studio](monitoring/how-to-monitor-pipeline-runs.md).
23+
24+
For monitoring Apache Spark applications, see [Monitor Apache Spark applications in Synapse Studio](monitoring/apache-spark-applications.md).
25+
26+
For monitoring SQL pools, see [Use Synapse Studio to monitor your SQL pools](monitoring/how-to-monitor-sql-pools.md).
27+
28+
For monitoring SQL requests, see [Monitor SQL requests in Synapse Studio](monitoring/how-to-monitor-sql-requests.md).
29+
30+
For information about how to use Dynamic Management Views (DMVs) to programmatically monitor Synapse SQL via T-SQL, see [DMVs](sql/query-history-storage-analysis.md#dmvs) and [Monitor your Azure Synapse Analytics dedicated SQL pool workload using DMVs](sql-data-warehouse/sql-data-warehouse-manage-monitor.md).

articles/synapse-analytics/monitor-synapse-analytics-reference.md

Lines changed: 45 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,39 @@ See [Monitor Azure Synapse Analytics](monitor-synapse-analytics.md) for details
2020
### Supported metrics for Microsoft.Synapse/workspaces
2121
The following table lists the metrics available for the Microsoft.Synapse/workspaces resource type.
2222
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
23-
[!INCLUDE [Microsoft.Synapse/workspaces](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-synapse-workspaces-metrics-include.md)]
23+
[!INCLUDE [microsoft-synapse-workspaces-metrics-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-synapse-workspaces-metrics-include.md)]
24+
25+
### Azure Synapse Link metrics
26+
27+
Azure Synapse Link emits the following metrics to Azure Monitor:
28+
29+
| **Metric** | **Aggregation types** | **Description** |
30+
|---------|---------|---------|
31+
| Link connection events | Sum | Number of Synapse Link connection events, including start, stop, and failure |
32+
| Link latency in seconds | Max, Min, Avg | Synapse Link data processing latency in seconds |
33+
| Link processed data volume (bytes) | Sum | Data volume in bytes processed by Synapse Link |
34+
| Link processed rows | Sum | Row counts processed by Synapse Link |
35+
| Link table events | Sum | Number of Synapse Link table events, including snapshot, removal, and failure |
2436

2537
### Supported metrics for Microsoft.Synapse/workspaces/bigDataPools
2638
The following table lists the metrics available for the Microsoft.Synapse/workspaces/bigDataPools resource type.
2739
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
28-
[!INCLUDE [Microsoft.Synapse/workspaces/bigDataPools](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-synapse-workspaces-bigdatapools-metrics-include.md)]
40+
[!INCLUDE [microsoft-synapse-workspaces-bigdatapools-metrics-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-synapse-workspaces-bigdatapools-metrics-include.md)]
2941

3042
### Supported metrics for Microsoft.Synapse/workspaces/kustoPools
3143
The following table lists the metrics available for the Microsoft.Synapse/workspaces/kustoPools resource type.
3244
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
33-
[!INCLUDE [Microsoft.Synapse/workspaces/kustoPools](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-synapse-workspaces-kustopools-metrics-include.md)]
45+
[!INCLUDE [microsoft-synapse-workspaces-kustopools-metrics-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-synapse-workspaces-kustopools-metrics-include.md)]
3446

3547
### Supported metrics for Microsoft.Synapse/workspaces/scopePools
3648
The following table lists the metrics available for the Microsoft.Synapse/workspaces/scopePools resource type.
3749
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
38-
[!INCLUDE [Microsoft.Synapse/workspaces/scopePools](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-synapse-workspaces-scopepools-metrics-include.md)]
50+
[!INCLUDE [microsoft-synapse-workspaces-scopepools-metrics-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-synapse-workspaces-scopepools-metrics-include.md)]
3951

4052
### Supported metrics for Microsoft.Synapse/workspaces/sqlPools
4153
The following table lists the metrics available for the Microsoft.Synapse/workspaces/sqlPools resource type.
4254
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
43-
[!INCLUDE [Microsoft.Synapse/workspaces/sqlPools](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-synapse-workspaces-sqlpools-metrics-include.md)]
55+
[!INCLUDE [microsoft-synapse-workspaces-sqlpools-metrics-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-synapse-workspaces-sqlpools-metrics-include.md)]
4456

4557
#### Details
4658

@@ -81,22 +93,22 @@ Use the `Result` dimension of the `IntegrationActivityRunsEnded`, `IntegrationPi
8193
[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
8294

8395
### Supported resource logs for Microsoft.Synapse/workspaces
84-
[!INCLUDE [Microsoft.Synapse/workspaces](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-synapse-workspaces-logs-include.md)]
96+
[!INCLUDE [microsoft-synapse-workspaces-logs-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-synapse-workspaces-logs-include.md)]
8597

8698
> [!NOTE]
8799
> The event **SynapseBuiltinSqlPoolRequestsEnded** is emitted only for queries that read data from storage. It's not emitted for queries that process only metadata.
88100
89101
### Supported resource logs for Microsoft.Synapse/workspaces/bigDataPools
90-
[!INCLUDE [Microsoft.Synapse/workspaces/bigDataPools](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-synapse-workspaces-bigdatapools-logs-include.md)]
102+
[!INCLUDE [microsoft-synapse-workspaces-bigdatapools-logs-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-synapse-workspaces-bigdatapools-logs-include.md)]
91103

92104
### Supported resource logs for Microsoft.Synapse/workspaces/kustoPools
93-
[!INCLUDE [Microsoft.Synapse/workspaces/kustoPools](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-synapse-workspaces-kustopools-logs-include.md)]
105+
[!INCLUDE [microsoft-synapse-workspaces-kustopools-logs-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-synapse-workspaces-kustopools-logs-include.md)]
94106

95107
### Supported resource logs for Microsoft.Synapse/workspaces/scopePools
96-
[!INCLUDE [Microsoft.Synapse/workspaces/scopePools](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-synapse-workspaces-scopepools-logs-include.md)]
108+
[!INCLUDE [microsoft-synapse-workspaces-scopepools-logs-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-synapse-workspaces-scopepools-logs-include.md)]
97109

98110
### Supported resource logs for Microsoft.Synapse/workspaces/sqlPools
99-
[!INCLUDE [Microsoft.Synapse/workspaces/sqlPools](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-synapse-workspaces-sqlpools-logs-include.md)]
111+
[!INCLUDE [microsoft-synapse-workspaces-sqlpools-logs-include](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-synapse-workspaces-sqlpools-logs-include.md)]
100112

101113
### Dynamic Management Views (DMVs)
102114

@@ -108,6 +120,8 @@ For more information on these logs, see the following information:
108120
- [sys.dm_pdw_waits](/sql/relational-databases/system-dynamic-management-views/sys-dm-pdw-waits-transact-sql?view=azure-sqldw-latest&preserve-view=true)
109121
- [sys.dm_pdw_sql_requests](/sql/relational-databases/system-dynamic-management-views/sys-dm-pdw-sql-requests-transact-sql?view=azure-sqldw-latest&preserve-view=true)
110122

123+
To view the list of DMVs that apply to Synapse SQL, see [System views supported in Synapse SQL](./sql/reference-tsql-system-views.md#dedicated-sql-pool-dynamic-management-views-dmvs).
124+
111125
[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
112126

113127
### Synapse Workspaces
@@ -138,6 +152,27 @@ Microsoft.Synapse/workspaces
138152
- [SynapseDXTableUsageStatistics](/azure/azure-monitor/reference/tables/SynapseDXTableUsageStatistics#columns)
139153
- [SynapseDXTableDetails](/azure/azure-monitor/reference/tables/SynapseDXTableDetails#columns)
140154

155+
### Available Apache Spark configurations
156+
157+
| Configuration name | Default value | Description |
158+
| ------------------ | ------------- | ----------- |
159+
| spark.synapse.logAnalytics.enabled | false | To enable the Log Analytics sink for the Spark applications, true. Otherwise, false. |
160+
| spark.synapse.logAnalytics.workspaceId | - | The destination Log Analytics workspace ID. |
161+
| spark.synapse.logAnalytics.secret | - | The destination Log Analytics workspace secret. |
162+
| spark.synapse.logAnalytics.keyVault.linkedServiceName | - | The Key Vault linked service name for the Log Analytics workspace ID and key. |
163+
| spark.synapse.logAnalytics.keyVault.name | - | The Key Vault name for the Log Analytics ID and key. |
164+
| spark.synapse.logAnalytics.keyVault.key.workspaceId | SparkLogAnalyticsWorkspaceId | The Key Vault secret name for the Log Analytics workspace ID. |
165+
| spark.synapse.logAnalytics.keyVault.key.secret | SparkLogAnalyticsSecret | The Key Vault secret name for the Log Analytics workspace |
166+
| spark.synapse.logAnalytics.uriSuffix | ods.opinsights.azure.com | The destination Log Analytics workspace [URI suffix](../azure-monitor/logs/data-collector-api.md#request-uri). If your workspace isn't in Azure global, you need to update the URI suffix according to the respective cloud. |
167+
| spark.synapse.logAnalytics.filter.eventName.match | - | Optional. The comma-separated spark event names, you can specify which events to collect. For example: `SparkListenerJobStart,SparkListenerJobEnd` |
168+
| spark.synapse.logAnalytics.filter.loggerName.match | - | Optional. The comma-separated log4j logger names, you can specify which logs to collect. For example: `org.apache.spark.SparkContext,org.example.Logger` |
169+
| spark.synapse.logAnalytics.filter.metricName.match | - | Optional. The comma-separated spark metric name suffixes, you can specify which metrics to collect. For example: `jvm.heap.used`|
170+
171+
> [!NOTE]
172+
> - For Microsoft Azure operated by 21Vianet, the `spark.synapse.logAnalytics.uriSuffix` parameter should be `ods.opinsights.azure.cn`.
173+
> - For Azure Government, the `spark.synapse.logAnalytics.uriSuffix` parameter should be `ods.opinsights.azure.us`.
174+
> - For any cloud except Azure, the `spark.synapse.logAnalytics.keyVault.name` parameter should be the fully qualified domain name (FQDN) of the Key Vault. For example, `AZURE_KEY_VAULT_NAME.vault.usgovcloudapi.net` for AzureUSGovernment.
175+
141176
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
142177

143178
- [Microsoft.Sql resource provider operations](/azure/role-based-access-control/permissions/databases#microsoftsql)

0 commit comments

Comments
 (0)