Scrap is a Rails Metal endpoint designed to expose various garbage and memory-related metrics about your app. It may be particularly useful in tracking down memory leaks.
To use it, simply install the plugin. This will provide a new url, /stats/scrap, which will report a number of metrics about your app.
For an example of the output, see http://tachyonsix.com/scrap.htm
Config
If present, Scrap will use a config/scrap.yml file. See the provided example file for a list of the configuration options accepted.
- max requests: How many requests to keep a record of. Older requests will be pushed out of the queue when the limit has been reached. Default is 150.
- max_objects: How many objects/deltas to show. Default is 50.
- classes: A hash of class names to do object counting on. Values may be "true" which prints the object count with a default set of options, or it may be a hash consisting of the following:
- print_objects: boolean - toggles the output of a representation of each instance of the type.
- show_fields: array - list of fields to show per instance. This actually invokes the "attributes" method of the object, so it's really only useful for ActiveRecord objects.
- small: boolean - if false, will not print counts in h3 tags. Default is true.
- min: integer - minimum count, if set, that an object must have to appear in the delta or top objects list. Default is nil.
Other considerations
Scrap will take advantage of many of the wonderful metrics provided by recent versions of Ruby Enterprise Edition. It will work with other versions of Ruby, but you'll get a lot more info out of it if you're running REE 1.8.6-20090201 or later.