End of Life Ruby 3.0 has reached end of life and gets no more fixes. Switch to Ruby 4.0 →

class method

GC.stat

GC.stat → Hash

GC.stat(hash) → hash

GC.stat(:key) → Numeric

# File tmp/rubies/ruby-3.0.5/gc.rb, line 169
def self.stat hash_or_key = nil
  Primitive.gc_stat hash_or_key
end

Returns a Hash containing information about the GC.

The hash includes information about internal statistics about GC such as:

Example

{
    :count=>0,
    :heap_allocated_pages=>24,
    :heap_sorted_length=>24,
    :heap_allocatable_pages=>0,
    :heap_available_slots=>9783,
    :heap_live_slots=>7713,
    :heap_free_slots=>2070,
    :heap_final_slots=>0,
    :heap_marked_slots=>0,
    :heap_eden_pages=>24,
    :heap_tomb_pages=>0,
    :total_allocated_pages=>24,
    :total_freed_pages=>0,
    :total_allocated_objects=>7796,
    :total_freed_objects=>83,
    :malloc_increase_bytes=>2389312,
    :malloc_increase_bytes_limit=>16777216,
    :minor_gc_count=>0,
    :major_gc_count=>0,
    :remembered_wb_unprotected_objects=>0,
    :remembered_wb_unprotected_objects_limit=>0,
    :old_objects=>0,
    :old_objects_limit=>0,
    :oldmalloc_increase_bytes=>2389760,
    :oldmalloc_increase_bytes_limit=>16777216
}

The contents of the hash are implementation specific and may be changed in the future.

If the optional argument, hash, is given, it is overwritten and returned. This is intended to avoid probe effect.

This method is only expected to work on C Ruby.

See also .start .stress .remove_stress_to_class .stress= also in 4.1 · 4.0 · 3.4 · 3.3 · 3.2 · 3.1

‹ prev.start next ›.stress