Memory

A set of tools for profiling memory in Ruby.

Features

Fast memory capture for million+ allocations.
Persist results to disk for vast aggregations and comparisons over time.

Installation

Add this line to your application's Gemfile:

$ bundle add 'memory'

Usage

Please browse the source code index or refer to the guides below.

Getting Started

This guide explains how to get started with memory, a Ruby gem for profiling memory allocations in your applications.

RSpec Integration

memory_sampler = nil
config.before(:all) do |example_group|
	name = example_group.class.description.gsub(/[^\w]+/, "-")
	path = "#{name}.mprof"
	
	skip if File.exist?(path)
	
	memory_sampler = Memory::Sampler.new
	memory_sampler.start
end

config.after(:all) do |example_group|
	name = example_group.class.description.gsub(/[^\w]+/, "-")
	path = "#{name}.mprof"
	
	if memory_sampler
		memory_sampler.stop
		
		File.open(path, "w", encoding: Encoding::BINARY) do |io|
			memory_sampler.dump(io)
		end
		
		memory_sampler = nil
	end
end

config.after(:suite) do
	memory_sampler = Memory::Sampler.new
	
	Dir.glob("*.mprof") do |path|
		$stderr.puts "Loading #{path}..."
		memory_sampler.load(File.read(path, encoding: Encoding::BINARY))
	end
	
	$stderr.puts "Memory usage:"
	memory_sampler.report.print
end

Raw Object Allocations

before = nil

config.before(:suite) do |example|
	3.times{GC.start}
	GC.disable
	before = ObjectSpace.count_objects
end

config.after(:suite) do |example|
	after = ObjectSpace.count_objects
	GC.enable
	
	$stderr.puts
	$stderr.puts "Object Allocations:"
	
	after.each do |key, b|
		a = before.fetch(key, 0)
		$stderr.puts "#{key}: #{a} -> #{b} = #{b-a} allocations"
	end
end

Releases

Please browse the releases for more details.

v0.11.1

Compresed Memory::Graph::Node JSON representation for leaf nodes.

v0.11.0

Remove support for Memory::Usage.of(..., via:) and instead use Memory::Graph.for which collects more detailed usage until the specified depth, at which point it delgates to Memory::Usage.of. This should be more practical.

v0.10.0

Add support for Memory::Usage.of(..., via:) for tracking reachability of objects.
Introduce Memory::Graph for computing paths between parent/child objects.

v0.9.0

Explicit ignore: and seen: parameters for Memory::Usage.of to allow customization of ignored types and tracking of seen objects.

v0.8.4

Fix bugs when printing reports due to interface mismatch with Memory::Usage.

v0.8.3

Handle Memory::Usage.of(number) without error.

v0.8.2

Fix several formatting issues.

v0.8.1

Skip over ObjectSpace::InternalObjectWrapper instances in Memory::Usage.of to avoid unbounded recursion.

v0.8.0

Removed old RSpec integration.
Introduced Memory::Usage and Memory::Usage.of(object) which recursively computes memory usage of an object and its contents.

v0.7.1

Ensure aggregate keys are safe for serialization (and printing).

Contributing

We welcome contributions to this project.

Fork it.
Create your feature branch (git checkout -b my-new-feature).
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin my-new-feature).
Create new Pull Request.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.