Skip to content

Commit 7c32d15

Browse files
committed
doc: document labelled perf metrics for mds/cephfs-mirror
Fixes: https://tracker.ceph.com/issues/64483 Fixes: https://tracker.ceph.com/issues/65171 Signed-off-by: Jos Collin <[email protected]>
1 parent 5535e72 commit 7c32d15

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

doc/cephfs/cephfs-mirroring.rst

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,69 @@ created, the mirror daemon will clear the failed state upon successful synchroni
398398
When mirroring is disabled, the respective `fs mirror status` command for the file system
399399
will not show up in command help.
400400

401+
Metrics
402+
-------
403+
404+
CephFS exports mirroring metrics as :ref:`Labeled Perf Counters` which will be consumed by the OCP/ODF Dashboard to provide monitoring of the Geo Replication. These metrics can be used to measure the progress of cephfs_mirror syncing and thus provide the monitoring capability. CephFS exports the following mirroring metrics, which are displayed using the ``counter dump`` command.
405+
406+
.. list-table:: Mirror Status Metrics
407+
:widths: 25 25 75
408+
:header-rows: 1
409+
410+
* - Name
411+
- Type
412+
- Description
413+
* - mirroring_peers
414+
- Gauge
415+
- The number of peers involved in mirroring
416+
* - directory_count
417+
- Gauge
418+
- The total number of directories being synchronized
419+
* - mirrored_filesystems
420+
- Gauge
421+
- The total number of filesystems which are mirrored
422+
* - mirror_enable_failures
423+
- Counter
424+
- Enable mirroring failures
425+
426+
.. list-table:: Replication Metrics
427+
:widths: 25 25 75
428+
:header-rows: 1
429+
430+
* - Name
431+
- Type
432+
- Description
433+
* - snaps_synced
434+
- Counter
435+
- The total number of snapshots successfully synchronized
436+
* - sync_bytes
437+
- Counter
438+
- The total bytes being synchronized
439+
* - sync_failures
440+
- Counter
441+
- The total number of failed snapshot synchronizations
442+
* - snaps_deleted
443+
- Counter
444+
- The total number of snapshots deleted
445+
* - snaps_renamed
446+
- Counter
447+
- The total number of snapshots renamed
448+
* - avg_sync_time
449+
- Gauge
450+
- The average time (ms) taken by all snapshot synchronizations
451+
* - last_synced_start
452+
- Gauge
453+
- The sync start time (ms) of the last synced snapshot
454+
* - last_synced_end
455+
- Gauge
456+
- The sync end time (ms) of the last synced snapshot
457+
* - last_synced_duration
458+
- Gauge
459+
- The time duration (ms) of the last synchronization
460+
* - last_synced_bytes
461+
- counter
462+
- The total bytes being synchronized for the last synced snapshot
463+
401464
Configuration Options
402465
---------------------
403466

@@ -410,6 +473,7 @@ Configuration Options
410473
.. confval:: cephfs_mirror_retry_failed_directories_interval
411474
.. confval:: cephfs_mirror_restart_mirror_on_failure_interval
412475
.. confval:: cephfs_mirror_mount_timeout
476+
.. confval:: cephfs_mirror_perf_stats_prio
413477

414478
Re-adding Peers
415479
---------------

0 commit comments

Comments
 (0)