process-instrumentation 0.1.1

data/lib/instrumentation/memory.rb

@@ -0,0 +1,25 @@
+module Instrumentation
+  # Reads RSS memory from the PID specified
+  class Memory
+    def initialize(pid)
+      @pid = pid
+    end
+
+    def read
+      case system
+      when :mac_os
+        rss_via_ps
+      else
+        raise "Unknown system #{system.inspect}"
+      end
+    end
+
+    def system
+      :mac_os
+    end
+
+    def rss_via_ps
+      `ps -o rss= -p #{@pid}`.strip.to_i
+    end
+  end
+end

data/lib/instrumentation/rack_app.rb

@@ -0,0 +1,22 @@
+require 'tubesock'
+
+module Instrumentation
+  # Main Rack application that serves the `websocket` data or the index page
+  class RackApp
+    def initialize(report)
+      @report = report
+      @view   = Instrumentation::View.new
+    end
+
+    def call(env)
+      if env['HTTP_UPGRADE'] == 'websocket'
+        socket = Tubesock.hijack(env)
+        socket.listen
+        @report.socket = socket
+        [-1, {}, []]
+      else
+        ['200', { 'Content-Type' => 'text/html' }, [@view.render]]
+      end
+    end
+  end
+end

data/lib/instrumentation/report.rb

@@ -0,0 +1,61 @@
+module Instrumentation
+  # Reads data from system and process information and writes it to
+  # websocket
+  class Report
+    attr_reader :memory, :loadavg
+    attr_accessor :socket
+
+    def initialize(pid)
+      @pid = pid
+      @sleep = 1
+      @memory = BoundedArray.new(300)
+      @loadavg = BoundedArray.new(300)
+      @socket = nil
+    end
+
+    def start
+      @thread = Thread.new do
+        loop do
+          read_data
+          send_data if socket
+          sleep @sleep
+        end
+      end
+    end
+
+    def read_data
+      now = Time.now.strftime('%FT%T')
+      @memory = @memory << [now, read_memory]
+      @loadavg = @loadavg << [now, read_loadavg]
+    rescue => error
+      puts "Error when reading data: #{error.inspect}"
+    end
+
+    def send_data
+      socket.send_data(event(:memory, @memory.items))
+      socket.send_data(event(:loadavg, @loadavg.items))
+    rescue => error
+      puts "Error when sending data: #{error.inspect}"
+    end
+
+    def event(name, data)
+      { data_type: name, data: data }.to_json
+    end
+
+    def read_memory
+      Memory.new(@pid).read
+    end
+
+    def read_loadavg
+      LoadAverage.new.read[:one]
+    end
+
+    def join
+      @thread.join
+    end
+
+    def shutdown
+      @thread.kill
+    end
+  end
+end

data/lib/instrumentation/version.rb

@@ -0,0 +1,3 @@
+module Instrumentation
+  VERSION = '0.1.1'.freeze
+end

data/lib/instrumentation/view.rb

@@ -0,0 +1,17 @@
+module Instrumentation
+  # Handles rendering of ERB templates and asset loading
+  class View
+    include Erb::View
+    template :index
+
+    def asset(path)
+      File.read(asset_root.join('lib/assets', path))
+    end
+
+    private
+
+    def asset_root
+      Instrumentation.root
+    end
+  end
+end

data/lib/instrumentation/webserver.rb

@@ -0,0 +1,36 @@
+module Instrumentation
+  # Webserver using `puma` that handles requests for stats
+  class Webserver
+    def initialize
+      @worker = nil
+    end
+
+    def run(app, opts = {})
+      config = build_config(opts.merge(app: app))
+
+      @launcher = Puma::Launcher.new(config, events: Puma::Events.stdio)
+      @worker = Thread.new { @launcher.run }
+    end
+
+    def join
+      @worker.join
+    end
+
+    def stop
+      @launcher.stop
+      @worker.kill
+    end
+
+    private
+
+    def build_config(opts)
+      Puma::Configuration.new do |c|
+        host = opts.fetch(:host, Puma::Configuration::DefaultTCPHost)
+        port = opts.fetch(:port, Puma::Configuration::DefaultTCPPort)
+
+        c.port port, host
+        c.app  opts.fetch(:app)
+      end
+    end
+  end
+end

data/lib/instrumentation.rb

@@ -0,0 +1,45 @@
+require 'instrumentation/version'
+require 'pathname'
+require 'json'
+require 'rack'
+require 'puma'
+require 'erb/view'
+
+Erb.root = Pathname.new(__FILE__).join('..', '..').join('lib/templates')
+
+# Instrumentation
+#
+# Start a server by calling:
+#   Instrumentation.start_server(Process.pid)
+#
+# By default the server is started on http://localhost:8080
+module Instrumentation
+  def start_server(pid:, port: 8080)
+    report = Report.new(pid)
+    app = RackApp.new(report)
+    server = Webserver.new
+
+    report.start
+    server.run(app, port: port)
+
+    [server, report].map(&:join)
+  rescue Interrupt => _
+    print "\n=> Shutting down instrumentation.\n"
+    report.shutdown
+    server.stop
+  end
+
+  def root
+    Pathname.new(__FILE__).join('..', '..')
+  end
+
+  module_function :start_server, :root
+end
+
+require 'instrumentation/bounded_array'
+require 'instrumentation/memory'
+require 'instrumentation/load_average'
+require 'instrumentation/rack_app'
+require 'instrumentation/report'
+require 'instrumentation/view'
+require 'instrumentation/webserver'

data/lib/templates/index.erb

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<head>
+  <meta charset="utf-8">
+  <style type="text/css"><%= asset('styles.css') %></style>
+</head>
+<body>
+  <div class="content">
+    <div class="container">
+      <div class="stats-column">
+        <h5>Memory Usage (RSS)</h5>
+        <h1 id="last-memory">-</h1>
+      </div>
+      <div class="chart-container">
+        <canvas id="memory" width="1000" height="300"></canvas>
+      </div>
+    </div>
+
+    <div class="container">
+      <div class="stats-column">
+        <h5>One Minute Load Avg</h5>
+        <h1 id="last-loadavg">-</h1>
+      </div>
+      <div class="chart-container">
+        <canvas id="loadavg" width="1000" height="300"></canvas>
+      </div>
+    </div>
+  </div>
+
+  <script charset="utf-8"><%= asset('chart.min.js') %></script>
+  <script charset="utf-8"><%= asset('application.js') %></script>
+</body>

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: process-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Felipe Philipp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: tubesock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: erb-view
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Monitor process memory and CPU over time
+email:
+- felipeelias@gmail.com
+executables:
+- instrument
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example.gif
+- exe/instrument
+- instrumentation.gemspec
+- lib/assets/application.js
+- lib/assets/chart.min.js
+- lib/assets/styles.css
+- lib/instrumentation.rb
+- lib/instrumentation/bounded_array.rb
+- lib/instrumentation/load_average.rb
+- lib/instrumentation/memory.rb
+- lib/instrumentation/rack_app.rb
+- lib/instrumentation/report.rb
+- lib/instrumentation/version.rb
+- lib/instrumentation/view.rb
+- lib/instrumentation/webserver.rb
+- lib/templates/index.erb
+homepage: https://github.com/felipeelias/instrumentation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Monitor process stats over time
+test_files: []