https://github.com/felipeelias/instrumentation
Monitor process stats over time
https://github.com/felipeelias/instrumentation
instrumentation monitoring ruby
Last synced: about 2 months ago
JSON representation
Monitor process stats over time
- Host: GitHub
- URL: https://github.com/felipeelias/instrumentation
- Owner: felipeelias
- License: mit
- Created: 2016-11-01T16:15:34.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-09-08T04:06:28.000Z (8 months ago)
- Last Synced: 2025-11-20T16:18:28.630Z (5 months ago)
- Topics: instrumentation, monitoring, ruby
- Language: Ruby
- Size: 3.93 MB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Instrumentation
[](https://travis-ci.org/felipeelias/instrumentation)
[](https://badge.fury.io/rb/erb-view)
[](https://codeclimate.com/github/felipeelias/instrumentation/maintainability)
Monitor any system stats and process memory usage over time.
## Installation
```
gem install process-instrumentation
```
## Usage
To monitor a process, get its PID from the system (using `ps aux | grep PROCESS_NAME`) and start the command:
```
$ instrument
```
Then go to `http://localhost:8080` and you'll see the graph of memory usage over time.
## Development/Testing
Install dependencies with:
```
bin/setup
```
Run tests with:
```
rake test
```
Run the local binary with:
```
exe/instrument
```
An interactive console with all files loaded is available on:
```
bin/console
```
## Documentation
You can generate documentation locally:
```
rake yard
```
Then open `doc/index.html` in your browser.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/felipeelias/instrumentation. 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.
Make sure that the code passes the style guidelines with:
```
rake rubocop
```
If you want to contribute with anything but don't know where to start, check the project's to-do list:
- [x] Auto-refresh report (fetch datapoints dynamically)
- [x] Implement Load average reader
- [x] Setup rubocop task
- [ ] Implement option parser for command line tool
- [ ] Add tests when the interface and functionality is defined
- [ ] Implement memory reader for Linux, that reads from `/proc//statm`, example [here][linux-statm]
- [ ] Implement CPU % reader
- [ ] Let user customize HTTP server port via command line
- [ ] Setup continuous integration
- [ ] Setup code climate
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
[linux-statm]: https://gist.github.com/pvdb/6240788