Skip to content

Commit dec5302

Browse files
committed
modify as required
1 parent 0967906 commit dec5302

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

articles/synapse-analytics/spark/apache-spark-azure-log-analytics.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Use Azure Log Analytics to collect and visualize metrics and logs (Preview)
3-
description: learn how to enable the Synapse built-in Azure Log Analytics connector for collecting and sending the Apache Spark application metrics and logs to your Azure Log Analytics workspace.
3+
description: Learn how to enable the Synapse built-in Azure Log Analytics connector for collecting and sending the Apache Spark application metrics and logs to your Azure Log Analytics workspace.
44
services: synapse-analytics
55
author: jejiang
66
ms.author: jejiang
@@ -9,11 +9,10 @@ ms.service: synapse-analytics
99
ms.topic: tutorial
1010
ms.subservice: spark
1111
ms.date: 03/25/2021
12+
ms.custom: references_regions
1213
---
1314
# Tutorial: Use Azure Log Analytics to collect and visualize metrics and logs (Preview)
1415

15-
## Overview
16-
1716
In this tutorial, you will learn how to enable the Synapse built-in Azure Log Analytics connector for collecting and sending the Apache Spark application metrics and logs to your [Azure Log Analytics workspace](/azure/azure-monitor/logs/quick-create-workspace). You can then leverage an Azure monitor workbook to visualize the metrics and logs.
1817

1918
## Configure Azure Log Analytics Workspace information in Synapse Studio
@@ -30,7 +29,8 @@ You can follow below documents to create a Log Analytics workspace:
3029
#### Option 1. Configure with Azure Log Analytics Workspace ID and Key
3130

3231
Copy the following Spark configuration, save it as **"spark_loganalytics_conf.txt"** and fill the parameters:
33-
- `<LOG_ANALYTICS_WORKSPACE_ID>`: Azure Log Analytics workspace id.
32+
33+
- `<LOG_ANALYTICS_WORKSPACE_ID>`: Azure Log Analytics workspace ID.
3434
- `<LOG_ANALYTICS_WORKSPACE_KEY>`: Azure Log Analytics key: **Azure portal > Azure Log Analytics workspace > Agents management > Primary key**
3535

3636
```properties
@@ -55,7 +55,8 @@ To configure an Azure Key Vault to store the workspace key, follow the steps:
5555
- **Value**: Type the **<LOG_ANALYTICS_WORKSPACE_KEY>** for the secret.
5656
- Leave the other values to their defaults. Click **Create**.
5757
5. Copy the following Spark configuration, save it as **"spark_loganalytics_conf.txt"** and fill the parameters:
58-
- `<LOG_ANALYTICS_WORKSPACE_ID>`: Azure Log Analytics workspace id.
58+
59+
- `<LOG_ANALYTICS_WORKSPACE_ID>`: Azure Log Analytics workspace ID.
5960
- `<AZURE_KEY_VAULT_NAME>`: The Azure Key Vault name you configured.
6061
- `<AZURE_KEY_VAULT_SECRET_KEY_NAME>` (Optional): The secret name in the Azure Key Vault for workspace key, default: "SparkLogAnalyticsSecret".
6162

@@ -80,10 +81,15 @@ To configure an Azure Key Vault linked service in Synapse Studio to store the wo
8081

8182
1. Follow all the steps in the `Option 2. Configure with an Azure Key Vault` section.
8283
2. Create an Azure Key vault linked service in Synapse Studio:
83-
- Navigate to **Synapse Studio > Manage > Linked services**, click **New** button.
84-
- Search **Azure Key Vault** in the search box.
85-
- Type a name for the linked service.
86-
- Choose your Azure key vault. Click **Create**.
84+
85+
a. Navigate to **Synapse Studio > Manage > Linked services**, click **New** button.
86+
87+
b. Search **Azure Key Vault** in the search box.
88+
89+
c. Type a name for the linked service.
90+
91+
d. Choose your Azure key vault. Click **Create**.
92+
8793
3. Add a `spark.synapse.logAnalytics.keyVault.linkedServiceName` item to Spark configuration.
8894

8995
```properties
@@ -122,7 +128,8 @@ You can upload the configuration file to your Synapse Spark pool in Synapse Stud
122128
- Click **Upload** and choose the **"spark_loganalytics_conf.txt"** created.
123129
- Click **Upload** and **Apply**.
124130

125-
![spark pool configuration](./media/apache-spark-azure-log-analytics/spark-pool-configuration.png)
131+
> [!div class="mx-imgBorder"]
132+
> ![spark pool configuration](./media/apache-spark-azure-log-analytics/spark-pool-configuration.png)
126133
127134
> [!NOTE]
128135
>
@@ -146,17 +153,21 @@ You can upload the configuration file to your Synapse Spark pool in Synapse Stud
146153
5. **Paste** over any json that exists.
147154
6. Then Press **Apply** then **Done Editing**.
148155

149-
![new workbook](./media/apache-spark-azure-log-analytics/new-workbook.png)
156+
> [!div class="mx-imgBorder"]
157+
> ![new workbook](./media/apache-spark-azure-log-analytics/new-workbook.png)
150158
151-
![import workbook](./media/apache-spark-azure-log-analytics/import-workbook.png)
159+
> [!div class="mx-imgBorder"]
160+
> ![import workbook](./media/apache-spark-azure-log-analytics/import-workbook.png)
152161
153162
Then, submit your Apache Spark application to the configured Spark pool. After the application goes to running state, choose the running application in the workbook dropdown list.
154163

155-
![workbook imange](./media/apache-spark-azure-log-analytics/workbook.png)
164+
> [!div class="mx-imgBorder"]
165+
> ![workbook imange](./media/apache-spark-azure-log-analytics/workbook.png)
156166
157167
And you can customize the workbook by Kusto query and configure alerts.
158168

159-
![kusto query and alerts](./media/apache-spark-azure-log-analytics/kusto-query-and-alerts.png)
169+
> [!div class="mx-imgBorder"]
170+
> ![kusto query and alerts](./media/apache-spark-azure-log-analytics/kusto-query-and-alerts.png)
160171
161172
## Sample Kusto queries
162173

@@ -197,7 +208,7 @@ For more information, see [Create, view, and manage log alerts using Azure Monit
197208
## Limitation
198209

199210
- Azure Synapse Analytics workspace with [managed virtual network](https://docs.microsoft.com/azure/synapse-analytics/security/synapse-workspace-managed-vnet) enabled is not supported.
200-
- The following regions are not yet supported:
211+
- The following regions aren't currently supported:
201212
- East US 2
202213
- Norway East
203214
- UAE North

0 commit comments

Comments
 (0)