aboutsummaryrefslogtreecommitdiffstats
path: root/gc.rb
diff options
context:
space:
mode:
authorPeter Zhu <peter@peterzhu.ca>2021-12-29 16:17:28 -0500
committerPeter Zhu <peter@peterzhu.ca>2021-12-29 16:20:50 -0500
commit52525b527b4605435110bd61fb9e04d82ca26ff7 (patch)
tree9132bb7c2710a539c5f93cb2f49065f78be534de /gc.rb
parent002fa2859962f22de8afdbeece04966ea57b7da9 (diff)
downloadruby-52525b527b4605435110bd61fb9e04d82ca26ff7.tar.gz
[Bug #18451] [ci skip] Update documentation for GC.stat
Adds documentation for keys `time`, `compact_count`, `read_barrier_faults`, `total_moved_objects`.
Diffstat (limited to 'gc.rb')
-rw-r--r--gc.rb9
1 files changed, 9 insertions, 0 deletions
diff --git a/gc.rb b/gc.rb
index 72637f3796..887fc06d26 100644
--- a/gc.rb
+++ b/gc.rb
@@ -136,6 +136,8 @@ module GC
# [count]
# The total number of garbage collections ran since application start
# (count includes both minor and major garbage collections)
+ # [time]
+ # The total time spent in garbage collections (in milliseconds)
# [heap_allocated_pages]
# The total number of `:heap_eden_pages` + `:heap_tomb_pages`
# [heap_sorted_length]
@@ -173,6 +175,13 @@ module GC
# The total number of minor garbage collections run since process start
# [major_gc_count]
# The total number of major garbage collections run since process start
+ # [compact_count]
+ # The total number of compactions run since process start
+ # [read_barrier_faults]
+ # The total number of times the read barrier was triggered during
+ # compaction
+ # [total_moved_objects]
+ # The total number of objects compaction has moved
# [remembered_wb_unprotected_objects]
# The total number of objects without write barriers
# [remembered_wb_unprotected_objects_limit]