https://github.com/redding/whysoslow
A little runner/printer to benchmark Ruby code blocks
https://github.com/redding/whysoslow
Last synced: 10 months ago
JSON representation
A little runner/printer to benchmark Ruby code blocks
- Host: GitHub
- URL: https://github.com/redding/whysoslow
- Owner: redding
- License: mit
- Created: 2012-02-20T21:46:13.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2018-04-04T22:53:22.000Z (about 8 years ago)
- Last Synced: 2024-03-15T03:55:13.938Z (over 2 years ago)
- Language: Ruby
- Homepage: https://github.com/redding/whysoslow
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Whysoslow
## Description
Whysoslow is a little runner/printer we wrote to benchmark our Ruby code. It runs a block of code, collects run time measurements, and can snapshot memory usage information at various points during execution.
It has no tests, shockingly sparse docs, and is more of an experiment at this point. It comes as is for now so use if you see fit. I will happily accept any pull requests for documentation, tests, extensions, and improvements.
## Usage
```ruby
require 'whysoslow'
printer = Whysoslow::DefaultPrinter.new({
:title => "Bench Report Title",
:verbose => true
})
runner = Whysoslow::Runner.new(@printer)
runner.run do
# ... some long running script or loop
runner.snapshot("mem usage during run")
# ... some more long running script or loop
end
```
## Output: DefaultPrinter
The DefaultPrinter outputs to an io stream ($stdout by default). It uses Ansi to output columned memory usage snapshot data and measurement data.
## Installation
Add this line to your application's Gemfile:
gem 'whysoslow'
And then execute:
$ bundle
Or install it yourself as:
$ gem install whysoslow
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request