process-instrumentation 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 884e34d5b80ad72326ee07ca0c154b4b7415e848
+  data.tar.gz: 9a3e73f618a51936b03a4c428a6e57258ce3c1f3
+SHA512:
+  metadata.gz: 5b787e31bda339cee7fc5ca44fb5fa9d42682a852c8ac73c0cfa1ffb001d7505094a6a1b2d324cc2b96bd953880139728094358964756d907c16c7822401807d
+  data.tar.gz: 2b846bc5a29e4b88e699d2592d44f7b762129ba18dd1daea7f45ca5e198314bb4a45ea07c46beec42705d63db6659b606b19e675afe388b22a5b0083b324793e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at felipeelias@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry', '~> 0.10'
+  gem 'rubocop', '~> 0.45'
+  gem 'yard', '~> 0.9'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Felipe Elias Philipp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Instrumentation
+
+[![Build Status](https://travis-ci.org/felipeelias/instrumentation.svg?branch=master)](https://travis-ci.org/felipeelias/instrumentation)
+
+Monitor any system stats and process memory usage over time.
+
+![Example](https://github.com/felipeelias/instrumentation/blob/4d74af4a8ad0c97cc2940dec92399e54dbfd4d5e/example.gif "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](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/<pid>/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

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new
+
+task default: :test

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'instrumentation'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/instrument

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'instrumentation'
+
+pid = ARGV.first || Process.pid
+Instrumentation.start_server(pid: pid)

data/instrumentation.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instrumentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'process-instrumentation'
+  spec.version       = Instrumentation::VERSION
+  spec.authors       = ['Felipe Philipp']
+  spec.email         = ['felipeelias@gmail.com']
+
+  spec.summary       = 'Monitor process stats over time'
+  spec.description   = 'Monitor process memory and CPU over time'
+  spec.homepage      = 'https://github.com/felipeelias/instrumentation'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-rg', '~> 5.0'
+
+  spec.add_dependency 'rack', '2.0.1'
+  spec.add_dependency 'tubesock', '0.2.7'
+  spec.add_dependency 'puma', '3.6.0'
+  spec.add_dependency 'erb-view', '~> 0.1'
+end

data/lib/assets/application.js

@@ -0,0 +1,87 @@
+function updateChart(chart, data) {
+  var values = data.map(function(value) { return value[1] });
+  var labels = data.map(function(value) { return value[0] });
+
+  chart.data.labels = labels;
+  chart.data.datasets[0].data = values;
+  chart.update();
+}
+
+function formatBytes(bytes) {
+  if (bytes <= 1024) {
+    return bytes.toString().concat("B");
+  } else if (bytes > 1024 && bytes <= 1000*1024) {
+    return (bytes / 1024).toFixed(1).toString().concat("MB");
+  } else {
+    return (bytes / 1024 / 1024).toFixed(1).toString().concat("GB");
+  }
+}
+
+Chart.defaults.global.defaultFontSize = 8;
+Chart.defaults.global.animation.duration = 500;
+Chart.defaults.global.legend.display = false;
+Chart.defaults.global.elements.line.backgroundColor = "rgba(0,0,0,0)";
+Chart.defaults.global.elements.line.borderColor = "rgba(0,0,0,0.9)";
+Chart.defaults.global.elements.line.borderWidth = 2;
+
+var defaultOptions = {
+  type: 'line',
+  data: {
+    labels: [],
+    datasets: [{
+      label: '',
+      data: [],
+      lineTension: 0.2,
+      pointRadius: 0
+    }]
+  },
+  options: {
+    scales: {
+      yAxes: [{
+        ticks: {
+          beginAtZero:true
+        }
+      }],
+      xAxes: [{
+        type: 'time',
+        time: {
+          unitStepSize: 110
+        },
+        minUnit: 'second',
+        gridLines: {
+          display: false
+        }
+      }]
+    }
+  },
+  tooltips: {
+    enabled: false
+  },
+  responsive: true,
+  maintainAspectRatio: false,
+  animation: false
+}
+
+var memoryChart = new Chart(document.getElementById('memory'), defaultOptions);
+var loadavgChart = new Chart(document.getElementById('loadavg'), defaultOptions);
+
+var lastMemory = document.getElementById('last-memory');
+var lastLoadavg = document.getElementById('last-loadavg');
+
+var socket = new WebSocket("ws://localhost:8080/");
+socket.onmessage = function (raw_event) {
+  var event = JSON.parse(raw_event.data)
+
+  switch (event.data_type) {
+    case 'memory':
+      updateChart(memoryChart, event.data)
+      lastMemory.textContent = formatBytes(event.data[event.data.length - 1][1]);
+      break;
+    case 'loadavg':
+      updateChart(loadavgChart, event.data)
+      lastLoadavg.textContent = event.data[event.data.length - 1][1];
+      break;
+    default:
+      break;
+  }
+}