windows_exporter/docs/collector.dfsr.md

dfsr collector

The dfsr collector exposes metrics for DFSR.

Collector is currently in an experimental state and testing of metrics has not been undertaken. Feedback on this collector is welcome.

Metric name prefix	dfsr
Data source	Perflib
Enabled by default?	No

Flags

--collector.dfsr.sources-enabled

Comma-separated list of DFSR Perflib sources to use. Supported values are connection, folder and volume. All sources are enabled by default

Metrics

Name	Description	Type	Labels
windows_dfsr_connection_bandwidth_savings_using_dfs_replication_ratio	Share of bandwidth (0-1) saved by the DFS Replication service for this connection, using a combination of remote differential compression (RDC) and other compression technologies, compared to transferring the files uncompressed. For example, 0.2 means DFS Replication used 20% less bandwidth.	gauge	connection
windows_dfsr_connection_bytes_received_total	Total bytes received for connection	counter	connection
windows_dfsr_connection_compressed_size_of_files_received_bytes_total	Total compressed size of files received on the connection, in bytes	counter	connection
windows_dfsr_connection_received_files_total	Total number of files received for connection	counter	connection
windows_dfsr_connection_rdc_received_bytes_total	Total bytes received on the connection while replicating files using Remote Differential Compression. This is the actual bytes received over the network without the networking protocol overhead	counter	connection
windows_dfsr_connection_rdc_compressed_size_of_received_files_bytes_total	Total compressed size of files received with Remote Differential Compression on the connection, in bytes. This is the number of bytes that would have been received had RDC not been used. This is not the actual number of bytes received over the network.	counter	connection
windows_dfsr_connection_rdc_received_files_total	Total number of files received using remote differential compression	counter	connection
windows_dfsr_connection_rdc_size_of_received_files_bytes_total	Total uncompressed size of files received with remote differential compression, in bytes. This is the number of bytes that would have been received had neither compression nor RDC been used. This is not the actual number of bytes received over the network.	counter	connection
windows_dfsr_connection_files_received_bytes_total	Total uncompressed size of files received on the connection, in bytes. This is the number of bytes that would have been received had DFS Replication compression not been used.	counter	connection
windows_dfsr_folder_bandwidth_savings_using_dfs_replication_ratio	Share of bandwidth (0-1) saved by the DFS Replication service for this replicated folder, using a combination of remote differential compression (RDC) and other compression technologies, compared to transferring the files uncompressed. For example, 0.2 means DFS Replication used 20% less bandwidth.	gauge	folder
windows_dfsr_folder_compressed_size_of_received_files_bytes_total	Total compressed size of files received for this folder, in bytes	counter	folder
windows_dfsr_folder_conflict_cleaned_up_bytes_total	Total size of conflict loser files and folders deleted from the Conflict and Deleted folder, in bytes.	counter	folder
windows_dfsr_folder_conflict_generated_bytes_total	Total size of conflict loser files and folders moved to the Conflict and Deleted folder, in bytes.	counter	folder
windows_dfsr_folder_conflict_cleaned_up_files_total	Number of conflict loser files deleted from the Conflict and Deleted folder.	counter	folder
windows_dfsr_folder_conflict_generated_files_total	Number of files and folders moved to the Conflict and Deleted folder	counter	folder
windows_dfsr_folder_conflict_folder_cleanups_total	Number of deletions of conflict loser files and folders in the Conflict and Deleted	counter	folder
windows_dfsr_folder_conflict_space_in_use_bytes	Total size of the conflict loser files and folders currently in the Conflict and Deleted folder	gauge	folder
windows_dfsr_folder_deleted_space_in_use_bytes	Total size (in bytes) of the deleted files and folders currently in the Conflict and Deleted folder.	gauge	folder
windows_dfsr_folder_deleted_cleaned_up_bytes_total	Total size (in bytes) of replicating deleted files and folders that were cleaned up from the Conflict and Deleted folder.	counter	folder
windows_dfsr_folder_deleted_generated_bytes_total	Total size (in bytes) of replicated deleted files and folders that were moved to the Conflict and Deleted folder after they were deleted from a replicated folder on a sending member.	counter	folder
windows_dfsr_folder_deleted_cleaned_up_files_total	Number of files and folders that were cleaned up from the Conflict and Deleted folder.	counter	folder
windows_dfsr_folder_deleted_generated_files_total	Number of deleted files and folders that were moved to the Conflict and Deleted folder.	counter	folder
windows_dfsr_folder_file_installs_retried_total	Total number of file installs that are being retried due to sharing violations or other errors encountered when installing the files. The DFS Replication service replicates staged files into a staging folder, uncompresses them in the Installing folder, and renames them to the target location. The second and third steps of this process are known as installing the file.	counter	folder
windows_dfsr_folder_file_installs_succeeded_total	Total number of files that were successfully received from sending members and installed locally on this server. The DFS Replication service replicates staged files into a staging folder, uncompresses them in the Installing folder, and renames them to the target location. The second and third steps of this process are known as installing the file.	counter	folder
windows_dfsr_folder_received_files_total	Total number of files received.	counter	folder
windows_dfsr_folder_rdc_received_bytes_total	Total number of bytes received in replicating files using Remote Differential Compression. This is the actual bytes received over the network without the networking protocol overhead.	counter	folder
windows_dfsr_folder_rdc_compressed_size_of_received_files_bytes_total	Total compressed size (in bytes) of the files received with Remote Differential Compression. This is the number of bytes that would have been received had RDC not been used. This is not the actual bytes received over the network.	counter	folder
windows_dfsr_folder_rdc_received_files_total	Total number of files received with Remote Differential Compression.	counter	folder
windows_dfsr_folder_rdc_files_received_bytes_total	Total uncompressed size (in bytes) of the files received with Remote Differential Compression. This is the number of bytes that would have been received had neither compression nor RDC been used. This is not the actual bytes received over the network.	counter	folder
windows_dfsr_folder_files_received_bytes_total	Total uncompressed size (in bytes) of the files received.	counter	folder
windows_dfsr_folder_staging_space_in_use_bytes	Total size of files and folders currently in the staging folder. This metric will fluctuate as staging space is reclaimed.	gauge	folder
windows_dfsr_folder_staging_cleaned_up_bytes_total	Total size (in bytes) of the files and folders that have been cleaned up from the staging folder.	counter	folder
windows_dfsr_folder_staging_generated_bytes_total	Total size (in bytes) of replicated files and folders in the staging folder created by the DFS Replication service since last restart.	counter	folder
windows_dfsr_folder_staging_cleaned_up_files_total	Total number of files and folders that have been cleaned up from the staging folder.	counter	folder
windows_dfsr_folder_staging_generated_files_total	Total number of times replicated files and folders have been staged by the DFS Replication service.	counter	folder
windows_dfsr_folder_dropped_updates_total	Total number of redundant file replication update records that have been ignored by the DFS Replication service because they did not change the replicated file or folder.	counter	folder
windows_dfsr_volume_database_commits_total	Total number of DFSR Volume database commits.	counter	volume
windows_dfsr_volume_database_lookups_total	Total number of DFSR Volume database lookups.	counter	volume
windows_dfsr_volume_usn_journal_unread_ratio	Share (0-1) of the volume USN journal that the DFS Replication service has not read and processed yet. A journal wrap occurs when it reaches 1.	gauge	volume
windows_dfsr_volume_usn_journal_accepted_records_total	Total number of USN journal records accepted.	counter	volume
windows_dfsr_volume_usn_journal_read_records_total	Total number of DFSR Volume USN journal records read.	counter	volume

Example metric

This collector does not yet have explained examples, we would appreciate your help adding them!

Useful queries

This collector does not yet have any useful queries added, we would appreciate your help adding them!

Alerting examples

This collector does not yet have alerting examples, we would appreciate your help adding them!