Skip to content

Commit df6100e

Browse files
authored
Update file-sync-monitoring.md
1 parent 446dcb8 commit df6100e

File tree

1 file changed

+43
-42
lines changed

1 file changed

+43
-42
lines changed

articles/storage/file-sync/file-sync-monitoring.md

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
---
22
title: Monitor Azure File Sync
3-
description: Review how to monitor your Azure File Sync deployment by using Azure Monitor, Storage Sync Service, and Windows Server.
3+
description: Monitor Azure File Sync metrics, server health, and cloud tiering by using Azure Monitor, Storage Sync Service, and Windows Server.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: how-to
7-
ms.date: 10/09/2023
7+
ms.date: 06/05/2024
88
ms.author: kendownie
99
---
1010

11-
# Monitor Azure File Sync
11+
# Monitor Azure File Sync metrics and health
1212

1313
Use Azure File Sync to centralize your organization's file shares in Azure Files, while keeping the flexibility, performance, and compatibility of an on-premises file server. Azure File Sync transforms Windows Server into a quick cache of your Azure file share. You can use any protocol that's available on Windows Server to access your data locally, including SMB, NFS, and FTPS. You can have as many caches as you need across the world.
1414

15-
This article describes how to monitor your Azure File Sync deployment by using Azure Monitor, Storage Sync Service and Windows Server.
15+
This article describes how to monitor your Azure File Sync deployment by using Azure Monitor, Storage Sync Service, and Windows Server. It covers the following scenarios:
1616

17-
The following scenarios are covered in this guide:
1817
- View Azure File Sync metrics in Azure Monitor.
1918
- Create alerts in Azure Monitor to proactively notify you of critical conditions.
2019
- View health of your Azure File Sync deployment using the Azure portal.
21-
- How to use the event logs and performance counters on your Windows Servers to monitor the health of your Azure File Sync deployment.
20+
- Use the event logs and performance counters on Windows Server to monitor the health of your Azure File Sync deployment.
2221

2322
## Azure Monitor
2423

@@ -70,7 +69,7 @@ Alerts proactively notify you when important conditions are found in your monito
7069
5. Fill in the **Alert details** like **Alert rule name**, **Description** and **Severity**.
7170
6. Click **Create alert rule** to create the alert.
7271

73-
> [!Note]
72+
> [!NOTE]
7473
> If you configure an alert using the Server Name dimension and the server is renamed, the alert will need to be updated to monitor the new server name.
7574
7675
The following table lists some example scenarios to monitor and the proper metric to use for the alert:
@@ -136,7 +135,7 @@ To view the health of a **server endpoint** in the portal, navigate to the **Syn
136135

137136
- To learn more, see [Azure Monitor](#azure-monitor).
138137

139-
> [!Note]
138+
> [!NOTE]
140139
> The charts in the Storage Sync Service portal have a time range of 24 hours. To view different time ranges or dimensions, use Azure Monitor.
141140
142141
## Windows Server
@@ -151,7 +150,7 @@ Use the Telemetry event log on the server to monitor registered server, sync, an
151150

152151
- Event ID 9102 is logged once a sync session completes. Use this event to determine if sync sessions are successful (**HResult = 0**) and if there are per-item sync errors (**PerItemErrorCount**). For more information, see the [sync health](/troubleshoot/azure/azure-storage/file-sync-troubleshoot-sync-errors?toc=/azure/storage/file-sync/toc.json#broken-sync) and [per-item errors](/troubleshoot/azure/azure-storage/file-sync-troubleshoot-sync-errors?toc=/azure/storage/file-sync/toc.json#how-do-i-see-if-there-are-specific-files-or-folders-that-are-not-syncing) documentation.
153152

154-
> [!Note]
153+
> [!NOTE]
155154
> Sometimes sync sessions fail overall or have a non-zero PerItemErrorCount. However, they still make forward progress, and some files sync successfully. You can see this in the Applied fields such as AppliedFileCount, AppliedDirCount, AppliedTombstoneCount, and AppliedSizeBytes. These fields tell you how much of the session succeeded. If you see multiple sync sessions fail in a row, and they have an increasing Applied count, give sync time to try again before you open a support ticket.
156155
157156
- Event ID 9121 is logged for each per-item error once the sync session completes. Use this event to determine the number of files that are failing to sync with this error (**PersistentCount** and **TransientCount**). Persistent per-item errors should be investigated, see [How do I see if there are specific files or folders that are not syncing?](/troubleshoot/azure/azure-storage/file-sync-troubleshoot-sync-errors?toc=/azure/storage/file-sync/toc.json#how-do-i-see-if-there-are-specific-files-or-folders-that-are-not-syncing).
@@ -196,18 +195,19 @@ The following performance counters for Azure File Sync are available in Performa
196195
| AFS Sync Operations\Total Sync File Operations/sec | Total number of files synced (upload and download). |
197196

198197
## Alert Examples
198+
199199
This section provides some example alerts for Azure File Sync.
200200

201-
> [!Note]
201+
> [!NOTE]
202202
> If you create an alert and it's too noisy, adjust the threshold value and alert logic.
203203
204204
### How to create an alert if the server endpoint health shows an error in the portal
205205

206206
1. In the **Azure portal**, navigate to respective **Storage Sync Service**.
207-
2. Go to the **Monitoring** section and click **Alerts**.
208-
3. Click on **+ New alert rule** to create a new alert rule.
207+
2. Go to the **Monitoring** section and select **Alerts**.
208+
3. Select **+ New alert rule** to create a new alert rule.
209209
4. Configure condition by clicking **Select condition**.
210-
5. Within **Configure signal logic** blade, click **Sync session result** under signal name.
210+
5. Within **Configure signal logic** blade, select **Sync session result** under signal name.
211211
6. Select the following dimension configuration:
212212
- Dimension name: **Server Endpoint Name**
213213
- Operator: **=**
@@ -218,18 +218,18 @@ This section provides some example alerts for Azure File Sync.
218218
- Aggregation type: **Maximum**
219219
- Threshold value: **1**
220220
- Evaluated based on: Aggregation granularity = **24 hours** | Frequency of evaluation = **Every hour**
221-
- Click **Done.**
222-
8. Click **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
223-
9. Fill in the **Alert details** like **Alert rule name**, **Description** and **Severity**.
224-
10. Click **Create alert rule**.
221+
- Select **Done.**
222+
8. Select **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
223+
9. Fill in the **Alert details** like **Alert rule name**, **Description**, and **Severity**.
224+
10. Select **Create alert rule**.
225225

226226
### How to create an alert if files are failing to sync to a server or cloud endpoint
227227

228228
1. In the **Azure portal**, navigate to respective **Storage Sync Service**.
229-
2. Go to the **Monitoring** section and click **Alerts**.
230-
3. Click on **+ New alert rule** to create a new alert rule.
231-
4. Configure condition by clicking **Select condition**.
232-
5. Within **Configure signal logic** blade, click **Files not syncing** under signal name.
229+
2. Go to the **Monitoring** section and select **Alerts**.
230+
3. Select **+ New alert rule** to create a new alert rule.
231+
4. Configure condition by selecting **Select condition**.
232+
5. Within **Configure signal logic** blade, select **Files not syncing** under signal name.
233233
6. Select the following dimension configuration:
234234
- Dimension name: **Server Endpoint Name**
235235
- Operator: **=**
@@ -241,17 +241,17 @@ This section provides some example alerts for Azure File Sync.
241241
- Threshold value: **100**
242242
- Evaluated based on: Aggregation granularity = **5 minutes** | Frequency of evaluation = **Every 5 minutes**
243243
- Click **Done.**
244-
8. Click **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
245-
9. Fill in the **Alert details** like **Alert rule name**, **Description** and **Severity**.
246-
10. Click **Create alert rule**.
244+
8. Select **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
245+
9. Fill in the **Alert details** like **Alert rule name**, **Description**, and **Severity**.
246+
10. Select **Create alert rule**.
247247

248248
### How to create an alert if a registered server is failing to communicate with the Storage Sync Service
249249

250250
1. In the **Azure portal**, navigate to respective **Storage Sync Service**.
251-
2. Go to the **Monitoring** section and click **Alerts**.
252-
3. Click on **+ New alert rule** to create a new alert rule.
253-
4. Configure condition by clicking **Select condition**.
254-
5. Within **Configure signal logic** blade, click **Server online status** under signal name.
251+
2. Go to the **Monitoring** section and select **Alerts**.
252+
3. Select **+ New alert rule** to create a new alert rule.
253+
4. Configure condition by selecting **Select condition**.
254+
5. Within **Configure signal logic** blade, select **Server online status** under signal name.
255255
6. Select the following dimension configuration:
256256
- Dimension name: **Server name**
257257
- Operator: **=**
@@ -262,19 +262,19 @@ This section provides some example alerts for Azure File Sync.
262262
- Aggregation type: **Maximum**
263263
- Threshold value (in bytes): **1**
264264
- Evaluated based on: Aggregation granularity = **1 hour** | Frequency of evaluation = **Every 30 minutes**
265-
- Note that the metrics are sent to Azure Monitor every 15 to 20 minutes. Do not set the **Frequency of evaluation** to less than 30 minutes (will generate false alerts).
266-
- Click **Done.**
267-
8. Click **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
268-
9. Fill in the **Alert details** like **Alert rule name**, **Description** and **Severity**.
269-
10. Click **Create alert rule**.
265+
- Note that the metrics are sent to Azure Monitor every 15 to 20 minutes. Don't set the **Frequency of evaluation** to less than 30 minutes, as doing so will generate false alerts.
266+
- Select **Done.**
267+
8. Select **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
268+
9. Fill in the **Alert details** like **Alert rule name**, **Description**, and **Severity**.
269+
10. Select **Create alert rule**.
270270

271-
### How to create an alert if the cloud tiering recall size has exceeded 500GiB in a day
271+
### How to create an alert if the cloud tiering recall size has exceeded 500 GiB in a day
272272

273273
1. In the **Azure portal**, navigate to respective **Storage Sync Service**.
274-
2. Go to the **Monitoring** section and click **Alerts**.
275-
3. Click on **+ New alert rule** to create a new alert rule.
276-
4. Configure condition by clicking **Select condition**.
277-
5. Within **Configure signal logic** blade, click **Cloud tiering recall size** under signal name.
274+
2. Go to the **Monitoring** section and select **Alerts**.
275+
3. Select **+ New alert rule** to create a new alert rule.
276+
4. Configure condition by selecting **Select condition**.
277+
5. Within **Configure signal logic** blade, select **Cloud tiering recall size** under signal name.
278278
6. Select the following dimension configuration:
279279
- Dimension name: **Server name**
280280
- Operator: **=**
@@ -285,12 +285,13 @@ This section provides some example alerts for Azure File Sync.
285285
- Aggregation type: **Total**
286286
- Threshold value (in bytes): **67108864000**
287287
- Evaluated based on: Aggregation granularity = **24 hours** | Frequency of evaluation = **Every hour**
288-
- Click **Done.**
289-
8. Click **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
290-
9. Fill in the **Alert details** like **Alert rule name**, **Description** and **Severity**.
291-
10. Click **Create alert rule**.
288+
- Select **Done.**
289+
8. Select **Select action group** to add an action group (email, SMS, etc.) to the alert either by selecting an existing action group or creating a new action group.
290+
9. Fill in the **Alert details** like **Alert rule name**, **Description**, and **Severity**.
291+
10. Select **Create alert rule**.
292292

293293
## Next steps
294+
294295
- [Planning for an Azure File Sync deployment](file-sync-planning.md)
295296
- [Consider firewall and proxy settings](file-sync-firewall-and-proxy.md)
296297
- [Deploy Azure File Sync](file-sync-deployment-guide.md)

0 commit comments

Comments
 (0)