Azure File Sync monitoring data reference

  • Article

This article contains all the monitoring reference information for this service.

See Monitor Azure File Sync for details on the data you can collect for Azure File Sync and how to use it.

Metrics

This section lists all the automatically collected platform metrics for this service. These metrics are also part of the global list of all platform metrics supported in Azure Monitor.

For information on metric retention, see Azure Monitor Metrics overview.

Supported metrics for Microsoft.StorageSync/storageSyncServices

The following table lists the metrics available for the Microsoft.StorageSync/storageSyncServices resource type.

Table headings

  • Metric - The metric display name as it appears in the Azure portal.
  • Name in Rest API - Metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Sync Session Result

Metric that logs a value of 1 each time the Server Endpoint successfully completes a Sync Session with the Cloud Endpoint		 ServerSyncSessionResult Count Average, Count, Total (Sum), Maximum, Minimum SyncGroupName, ServerEndpointName, SyncDirection PT1M Yes
Bytes synced

Total file size transferred for Sync Sessions		 StorageSyncBatchTransferredFileBytes Bytes Average, Total (Sum) SyncGroupName, ServerEndpointName, SyncDirection PT1M Yes
Cloud tiering cache hit rate

Percentage of bytes that were served from the cache		 StorageSyncComputedCacheHitRate Percent Average SyncGroupName, ServerName, ServerEndpointName PT1M Yes
Cache data size by last access time

Size of data by last access time		 StorageSyncDataSizeByAccessPattern Bytes Average, Maximum, Minimum SyncGroupName, ServerName, ServerEndpointName, LastAccessTime PT1M No
Cloud tiering size of data tiered by last maintenance job

Size of data tiered during last maintenance job		 StorageSyncIncrementalTieredDataSizeBytes Bytes Total (Sum), Average, Maximum, Minimum SyncGroupName, ServerName, ServerEndpointName, TieringReason PT1M Yes
Cloud tiering low disk space mode

Indicates if the server endpoint is in low disk space mode or not (1=yes; 0=no)		 StorageSyncLowDiskModeCount Count Count, Minimum, Maximum, Total (Sum) SyncGroupName, ServerName, ServerEndpointName PT1M Yes
Cloud tiering recall success rate

Percentage of all recalls that were successful		 StorageSyncRecallComputedSuccessRate Percent Average SyncGroupName, ServerName, ServerEndpointName PT1M Yes
Cloud tiering recall size by application

Size of data recalled by application		 StorageSyncRecalledNetworkBytesByApplication Bytes Average, Total (Sum) SyncGroupName, ServerName, ApplicationName PT1M Yes
Cloud tiering recall size

Size of data recalled		 StorageSyncRecalledTotalNetworkBytes Bytes Average, Total (Sum) SyncGroupName, ServerName, ServerEndpointName PT1M Yes
Cloud tiering recall throughput

Size of data recall throughput		 StorageSyncRecallThroughputBytesPerSecond BytesPerSecond Average, Total (Sum), Maximum, Minimum SyncGroupName, ServerName, ServerEndpointName PT1M Yes
Server Online Status

Metric that logs a value of 1 each time the resigtered server successfully records a heartbeat with the Cloud Endpoint		 StorageSyncServerHeartbeat Count Average, Count, Total (Sum), Maximum, Minimum ServerName PT1M Yes
Files Synced

Count of Files synced		 StorageSyncSyncSessionAppliedFilesCount Count Average, Total (Sum) SyncGroupName, ServerEndpointName, SyncDirection PT1M Yes
Files not syncing

Count of files failed to sync		 StorageSyncSyncSessionPerItemErrorsCount Count Average SyncGroupName, ServerEndpointName, SyncDirection PT1M Yes
Cloud tiering size of data tiered

Size of data tiered to Azure file share		 StorageSyncTieredDataSizeBytes Bytes Average, Total (Sum), Maximum, Minimum SyncGroupName, ServerName, ServerEndpointName PT1M Yes
Server cache size

Size of data cached on the server		 StorageSyncTieringCacheSizeBytes Bytes Average, Maximum, Minimum SyncGroupName, ServerName, ServerEndpointName PT1M Yes

Metric dimensions

For information about what metric dimensions are, see Multi-dimensional metrics.

This service has the following dimensions associated with its metrics.

  • ApplicationName
  • LastAccessTime
  • ServerEndpointName
  • ServerName
  • SyncDirection
  • SyncGroupName
  • TieringReason

Activity log

The linked table lists the operations that may be recorded in the activity log for this service. This is a subset of all the possible resource provider operations in the activity log.

For more information on the schema of activity log entries, see Activity Log schema.

Related content