---
title: Azure File Sync
description: >-
  Monitor Azure File Sync sessions, throughput, cache efficiency, tiering, and
  agent health.
breadcrumbs: Docs > Integrations > Azure File Sync
---

> For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt).

# Azure File Sync
Integration version1.0.0
{% callout %}
# Important note for users on the following Datadog sites: us2.ddog-gov.com

{% alert level="info" %}
To find out if this integration is available in your organization, see your [Datadog Integrations](https://app.datadoghq.com/integrations) page or ask your organization administrator.

To initiate an exception request to enable this integration for your organization, email [support@ddog-gov.com](mailto:support@ddog-gov.com).
{% /alert %}

{% /callout %}

## Overview{% #overview %}

Azure File Sync centralizes file shares in Azure Files while retaining local Windows Server access. This integration collects sync health, throughput, cache efficiency, recall, tiering, and agent lifecycle metrics across the `Microsoft.StorageSync` resource provider.

## Setup{% #setup %}

### Installation{% #installation %}

If you haven't already, set up the [Microsoft Azure integration](https://docs.datadoghq.com/integrations/azure.md) first. There are no other installation steps.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **azure.storagesync_storagesyncservices.count**(gauge)                                                    | The count of Azure File Sync resources.                                                                                         |
| **azure.storagesync_storagesyncservices.server_sync_session_result**(gauge)                            | Emits a value of 1 each time a server endpoint successfully completes a sync session with the cloud endpoint.*Shown as session* |
| **azure.storagesync_storagesyncservices.storage_sync_batch_transferred_file_bytes**(gauge)           | Total file size transferred for sync sessions.*Shown as byte*                                                                   |
| **azure.storagesync_storagesyncservices.storage_sync_computed_cache_hit_rate**(gauge)                | Percentage of bytes that were served from the cache.*Shown as percent*                                                          |
| **azure.storagesync_storagesyncservices.storage_sync_data_size_by_access_pattern**(gauge)           | Size of cached data by last access time.*Shown as byte*                                                                         |
| **azure.storagesync_storagesyncservices.storage_sync_incremental_tiered_data_size_bytes**(gauge)    | Size of data tiered during last maintenance job.*Shown as byte*                                                                 |
| **azure.storagesync_storagesyncservices.storage_sync_low_disk_mode_count**(gauge)                    | Indicates whether the server endpoint is in low disk mode: 1 if it is, 0 if it is not.                                          |
| **azure.storagesync_storagesyncservices.storage_sync_recall_computed_success_rate**(gauge)           | Percentage of all recalls that were successful.*Shown as percent*                                                               |
| **azure.storagesync_storagesyncservices.storage_sync_recalled_network_bytes_by_application**(gauge) | Size of data recalled by application.*Shown as byte*                                                                            |
| **azure.storagesync_storagesyncservices.storage_sync_recalled_total_network_bytes**(gauge)           | Size of data recalled.*Shown as byte*                                                                                           |
| **azure.storagesync_storagesyncservices.storage_sync_recall_throughput_bytes_per_second**(gauge)    | Throughput of data recalled to the server.*Shown as byte*                                                                       |
| **azure.storagesync_storagesyncservices.storage_sync_server_heartbeat**(gauge)                         | Emits a value of 1 each time a registered server successfully records a heartbeat with the cloud endpoint.                      |
| **azure.storagesync_storagesyncservices.storage_sync_sync_session_applied_files_count**(gauge)      | Count of files synced.*Shown as file*                                                                                           |
| **azure.storagesync_storagesyncservices.storage_sync_sync_session_per_item_errors_count**(gauge)   | Count of files that failed to sync.*Shown as file*                                                                              |
| **azure.storagesync_storagesyncservices.storage_sync_tiered_data_size_bytes**(gauge)                 | Size of data tiered to the Azure file share.*Shown as byte*                                                                     |
| **azure.storagesync_storagesyncservices.storage_sync_tiering_cache_size_bytes**(gauge)               | Size of data cached on the server.*Shown as byte*                                                                               |
| **azure.storagesync_storagesyncservices.storage_sync_agent_version_expiration_days**(gauge)          | Number of days until the agent version expires.*Shown as day*                                                                   |

### Service Checks{% #service-checks %}

Azure File Sync does not include any service checks.

### Events{% #events %}

Azure File Sync does not include any events.

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).