Project

gctime

0.0
The project is in a healthy, maintained state
Exposes a monotonically increasing GC total_time metric.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies
 Project Readme

GCTime

Exposes a monotonically increasing GC total_time metric.

Installation

Add this line to your application's Gemfile:

gem 'gctime'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install gctime

Usage

require 'gctime'
>> GCTime.total_time
=> 0.0
>> GCTime.enable
=> nil
>> 4.times { GC.start }
=> 4
>> GCTime.total_time
=> 127.42100000000012 # ms
>> GCTime.disable
=> nil

GCTime.total_time returns a Float representing the total number of milliseconds spent in GC.

Incompatibilities

CGTime relies on the built-in GC::Profiler which is a stateful datastructure. Which mean any other gem or application code using it is likely incompatoble with GCTime and will likely lead to incorrect timings.

Known incompatible gems are:

If you suspect that one of your gem might be using GC::Profiler.clear, you can check with grep -R 'GC::Profiler.clear' $(bundle show --paths).

Memory Leak

It is important to note that the underlying GC::Profiler keeps internal records of all GC triggers. Every time GCTime.total_time is called the datastructure is reset, but if it isn't called on a regular basis, it might lead to a memory leak.

Make sure to either call it on a regular basis, or to disable it when it's no longer needed.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/gctime.

License

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