Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wnuqui/method_meter
MethodMeter is a library module that instruments methods defined in a given object.
https://github.com/wnuqui/method_meter
instrumentation profiler slow-methods
Last synced: 4 days ago
JSON representation
MethodMeter is a library module that instruments methods defined in a given object.
- Host: GitHub
- URL: https://github.com/wnuqui/method_meter
- Owner: wnuqui
- License: mit
- Created: 2018-03-18T10:09:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-14T18:48:03.000Z (almost 4 years ago)
- Last Synced: 2024-12-18T16:36:46.501Z (about 1 month ago)
- Topics: instrumentation, profiler, slow-methods
- Language: Ruby
- Size: 644 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MethodMeter [![Build Status](https://wnuqui.semaphoreci.com/badges/method_meter/branches/master.svg?style=shields)](https://wnuqui.semaphoreci.com/projects/method_meter)
`MethodMeter` is a library module that instruments **methods defined in a given object**. These methods are NOT from included or extended modules. These methods are also NOT from parent objects. By object, it means either a `class` or `module`.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'method_meter'
```And then execute:
$ bundle
Or install it yourself as:
$ gem install method_meter
## Usage
```ruby
MethodMeter.observe ArithmeterMethodMeter.measure!('key-1') do
arithmeter = Arithmeter.new
arithmeter.add 1, 3Arithmeter.sum 1, 3
arithmeter = Arithmeter.new
arithmeter.add 4, 3Arithmeter.sum 4, 3
endap MethodMeter.data
ap MethodMeter.measurement
```More examples found here: https://github.com/wnuqui/method_meter/tree/master/examples
## In action
![method_meter in action](1-basic-rb.gif)
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/wnuqui/method_meter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the MethodMeter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/method_meter/blob/master/CODE_OF_CONDUCT.md).
## Acknowledgement
This library is based from https://github.com/change/method_profiler. This library is a bit more in terms of methods that it can observe. Also how it observe methods is completely different one than that of `method_profiler`. Please feel free to check the details in the code. :-)