Memory::Profiler

Getting Started

This guide explains how to use memory-profiler to automatically detect and diagnose memory leaks in Ruby applications.

Rack Integration

This guide explains how to integrate memory-profiler into Rack applications for automatic memory leak detection.

v1.5.1

• Improve performance of object table.

v1.5.0

• Add Capture#each_object for getting all retained objects.
• Add retained_addresses: option to Sampler#analyze to capture addresses.
• Add Sampler#analyze(retained_minimum: 100) - if the retained_size is less than this, the analyse won't proceed.
• Remove Memory::Profiler::Graph - it's too slow for practical use.
• Add Memory::Profiler.address_of(object) to get the memory address of an object.

v1.4.0

• Implement Cooper-Harvey-Kennedy algorithm for finding root objects in memory leaks.
• Rework capture to track objects by object_id exclusively.

v1.3.0

• Breaking: Renamed Capture#count_for to Capture#retained_count_of for better clarity and consistency.
• Breaking: Changed CallTree#top_paths(limit) to CallTree#top_paths(limit:) - now uses keyword argument.
• Breaking: Changed CallTree#hotspots(limit) to CallTree#hotspots(limit:) - now uses keyword argument.
• Simplified Sampler#analyze return structure to {allocations: {...}, call_tree: {...}} format.
• Added Allocations#as_json and Allocations#to_json methods for JSON serialization.
• Added CallTree#as_json and CallTree#to_json methods for JSON serialization with configurable options.
• Memory::Profiler::Allocations.new can now be instantiated directly (primarily for testing).
• Sampler#statistics is now a deprecated alias for Sampler#analyze.
• Breaking: Removed Sampler#all_statistics method.

v1.2.0

• Enable custom depth: and filter: options to Sampler#track.
• Change default filter to no-op.
• Add option to run GC with custom options before each sample to reduce noise.
• Always report sampler statistics after each sample.

v1.1.15

• Ignore freeobj for classes that are not being tracked.

v1.1.14

• Ignore freeobj events for objects with anonymous classes that are not tracked (and thus become T_NONE).

v1.1.13

• Fix sampler loop interval handling.
• Log capture statistics from sampler run loop.

v1.1.12

• Use rb_obj_id for tracking object states to avoid compaction issues.

v1.1.11

• Double buffer shared events queues to fix queue corruption.