benchmark-malloc

Benchmark::Malloc

Trace memory allocations and collect stats.

The Benchmark::Malloc is used by rspec-benchmark

Installation

Add this line to your application's Gemfile:

gem 'benchmark-malloc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install benchmark-malloc

Usage

bench_malloc = Benchmark::Malloc.new

stats = bench_malloc.run { %w[foo bar baz].sort[1] }

stats.allocated.total_objects # => 3

stats.allocated.total_memory # => 120

API

start & stop

You can manually begin tracing memory allocations with the start method:

malloc = Benchmark::Malloc.new
malloc.start

Any Ruby code after the start invocation will count towards the stats:

%w[foo bar baz].sort[1]

Finally, to finish tracing call the stop method:

malloc.stop

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/benchmark-malloc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Benchmark::Malloc project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Copyright

Copyright (c) 2019 Piotr Murach. See LICENSE for further details.