No release in over 3 years
Low commit activity in last 3 years
Monitor process memory and CPU over time
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 5.0
~> 12.0

Runtime

~> 0.1
~> 3.6
~> 2.0
~> 0.2
 Project Readme

Instrumentation

Build Status Gem Version Maintainability

Monitor any system stats and process memory usage over time.

Example

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 <pid>

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 <pid>

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 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:

  • Auto-refresh report (fetch datapoints dynamically)
  • Implement Load average reader
  • 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/<pid>/statm, example here
  • 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.