resource_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32aa3a39198facc9dc8a8a7d841922e8bdbfd539
+  data.tar.gz: 64ece18593944af62e3c625eff499b6c885648e9
+SHA512:
+  metadata.gz: 30e746e4f8a0e04d2b799b6d95769653daa7a8e80abcab0220def11d103cc8cf6985f61ee7de3ef4af87ce276959ff096bc43015e5f03eda6571d89946a8e4a3
+  data.tar.gz: 410394aef801e12c85a6ac220dffe4c51b183a029c93ed7281281a9ae2262b3cdd373e74200be35cbf9eb8206bd76a17763e0ac12a339dfff037ee7d12c80f90

data/.gitignore

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

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 lazherrera@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resource_monitor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lazaro Herrera
+
+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,89 @@
+# ResourceMonitor
+
+This is a simple rails resource monitoring gem.
+
+Requires ActionCable and Rails 5.0+, and is optimized to run under Linux / Mac servers.
+
+Creates a simple page under /resources/ that is updated with CPU/RAM usage in realtime.
+
+Although not a major performance hog, this should only be run in production when there is evidence of resource overuse, look under the Usage section for instructions for disabling the gem.
+
+Current Project Status: Usable
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resource_monitor'
+```
+
+And then execute:
+
+    $ bundle install
+
+This following line will add a set of views/controllers/and channels into your app.
+
+    $ rake resource_monitor:install_dashboard
+
+And then add the following to the top of your application.rb file
+You can also only add it to the controllers you think may be causing some issues.
+
+```ruby
+before_action :resource_monitor_app
+after_action :resource_monitor_app
+
+def resource_monitor_app
+  ResourceMonitor.benchmark(self)
+end
+```
+
+## Uninstall
+
+If you added the dashboard to your project, you can remove it using this.
+
+    $ rake resource_monitor:uninstall_dashboard
+
+This will leave behind a "resource" folder in your views but it's less risky than removing folders from your views folder.
+
+## Usage
+
+You can try out the gem by using
+
+    $ rake resource_monitor:console
+
+Once inside irb, you can use the following
+
+```ruby
+  ResourceMonitor.benchmark(self)
+```
+
+Install the dashboard, deploy and browse to /resources/.
+
+If you want to disable this, you can easily comment out the contents of resource_monitor_app or use an ENV variable such as below.
+
+```ruby
+before_action :resource_monitor_app
+after_action :resource_monitor_app
+
+def resource_monitor_app
+  if ENV['MONITORING_ENABLED']
+    ResourceMonitor.benchmark(self)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `rake resource_monitor: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/WriteCodeEveryday/resource_monitor.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Dir.glob('lib/tasks/*.rake').each {|r| import r}

data/app/channels/resource_channel.rb

@@ -0,0 +1,6 @@
+class ResourceChannel < ApplicationCable::Channel
+  def subscribed
+    stream_from "resources"
+    ResourceMonitor.benchmark()
+  end
+end

data/app/controllers/resource_controller.rb

@@ -0,0 +1,5 @@
+class ResourceController < ApplicationController
+  def index
+    render layout: false
+  end
+end

data/app/views/resource/index.html.erb

@@ -0,0 +1,79 @@
+<html>
+  <head></head>
+  <body>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+    <link href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+    <script>
+      App.cable = ActionCable.createConsumer("//<%= request.host_with_port %>/cable");
+      //App.cable = ActionCable.createConsumer("ws://localhost:3000/websocket");
+      App.data = App.cable.subscriptions.create({ channel: "ResourceChannel" }, {
+        received: function(data) {
+          var json = JSON.parse(data)
+          var process_id = json['process_id']
+          var cpu_percentage = json['cpu_percentage']
+          var ram_percentage = json['ram_percentage']
+          var ram_usage = json['ram_usage']
+          var last_executed_controller = json['last_executed_controller']
+          var last_executed_action = json['last_executed_action']
+
+
+          var execution_details_td = jQuery('<td/>', {
+            text: ""
+          });
+
+          var controller_details =  jQuery('<p>',{
+            text: "Controller: " +last_executed_controller
+          })
+
+          var action_details = jQuery('<p>',{
+            text: "Action: "  + last_executed_action
+          })
+
+          var ram_usage_td = jQuery('<td/>', {
+            text: ram_usage + " MB"
+          });
+
+          var ram_percentage_td= jQuery('<td/>', {
+            text: ram_percentage + "%"
+          });
+
+          var cpu_percentage_td= jQuery('<td/>', {
+            text: cpu_percentage + "%"
+          });
+
+          var process_id_td = jQuery('<td/>', {
+            text: process_id
+          });
+
+          var main_tr =  $('<tr></tr>')
+          var table_body = $("#table_body")
+          process_id_td.appendTo(main_tr)
+          cpu_percentage_td.appendTo(main_tr)
+          ram_percentage_td.appendTo(main_tr)
+          ram_usage_td.appendTo(main_tr)
+          controller_details.appendTo(execution_details_td)
+          action_details.appendTo(execution_details_td)
+          execution_details_td.appendTo(main_tr)
+          main_tr.prependTo(table_body)
+        }
+      });
+    </script>
+    <div id="holder" class="container">
+      <h2>ResourceMonitorDashboard</h2>
+      <table class="table table-striped">
+        <thead>
+          <tr>
+            <th>Process ID</th>
+            <th>CPU Percentage</th>
+            <th>RAM Percentage</th>
+            <th>RAM Usage (MB)</th>
+            <th>Execution Details</th>
+          </tr>
+        </thead>
+        <tbody id="table_body">
+        </tbody>
+      </table>
+    </div>
+  </body>
+</html>

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/lib/resource_monitor.rb

@@ -0,0 +1,29 @@
+require "resource_monitor/version"
+require "resource_monitor/railtie" if defined?(Rails)
+
+module ResourceMonitor
+  def self.benchmark(controller=nil)
+    # Recover the process id and memory usage in KB (http://stackoverflow.com/questions/7220896/get-current-ruby-process-memory-usage)
+    pid, size, cpu_per, mem_per = `ps ax -o pid,rss,%cpu,%mem | grep -E "^[[:space:]]*#{$$}"`.strip.split.map(&:to_i)
+
+    if defined?(Rails)
+      last_executed_controller = controller&.controller_name&.presence  || controller&['controller_name']&.presence  || 'NoController'
+      last_executed_action = controller&.action_name&.presence || controller&['action_name']&.presence || 'NoAction'
+    else
+      last_executed_controller = controller&.controller_name ||  'NoController'
+      last_executed_action = controller&.action_name || 'NoAction'
+    end
+
+    data = {
+      process_id: pid,
+      cpu_percentage: cpu_per,
+      ram_percentage: mem_per,
+      ram_usage: (size / 1024).to_i,
+      last_executed_controller: last_executed_controller,
+      last_executed_action: last_executed_action
+    }
+
+    ActionCable.server.broadcast 'resources', data.to_json if defined?(ActionCable)
+    return data
+  end
+end

data/lib/resource_monitor/railtie.rb

@@ -0,0 +1,5 @@
+class ResourceMonitor::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/rm_console.rake'
+  end
+end

data/lib/resource_monitor/version.rb

@@ -0,0 +1,3 @@
+module ResourceMonitor
+  VERSION = "0.1.0"
+end

data/lib/tasks/rm_console.rake

@@ -0,0 +1,39 @@
+namespace :resource_monitor do
+  # Works perfectly as a quick test environment.
+  task :console do
+    require 'irb'
+    require 'irb/completion'
+    require 'resource_monitor' # You know what to do.
+    ARGV.clear
+    IRB.start
+  end
+
+  # Works correctly.
+  task :install_dashboard do
+    if defined?(Rails)
+      path = Gem.loaded_specs['resource_monitor'].full_gem_path
+      puts "Copying from #{path}/app/ to #{Rails.root.to_s}/app/"
+      FileUtils.cp_r "#{path}/app/.", "#{Rails.root.to_s}/app/"
+      puts "IMPORTANT: Remember to add the following route to your config/routes.rb"
+      puts "get '/resources/' => 'resource#index'"
+    else
+      puts "This installer should be run inside a Rails project."
+    end
+  end
+
+  # Does nothing at all.
+  task :uninstall_dashboard do
+    if defined?(Rails)
+      path = Gem.loaded_specs['resource_monitor'].full_gem_path
+      records = Dir.glob("#{path}/app/**/**").select { |f| File.file?(f) }
+      records.each do |item|
+        puts "Removing #{Rails.root.to_s}#{item.split(path)[1]}"
+        FileUtils.rm "#{Rails.root.to_s}#{item.split(path)[1]}"
+      end
+      puts "IMPORTANT: Remember to remove the following route from your config/routes.rb"
+      puts "get '/resources/' => 'resource#index'"
+    else
+      puts "This uninstaller should be run inside a Rails project."
+    end
+  end
+end

data/resource_monitor.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resource_monitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resource_monitor"
+  spec.version       = ResourceMonitor::VERSION
+  spec.authors       = ["Lazaro Herrera"]
+  spec.email         = ["lazherrera@gmail.com"]
+
+  spec.summary       = %q{A Rails 5 ActionCable gem for simple resource usage monitoring.}
+  spec.description   = %q{This gem creates a dashboard for monitoring of ongoing CPU/RAM usage of your processes.}
+  spec.homepage      = "http://writecodeeveryday.github.io/projects/resource_monitor"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "actioncable"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: resource_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lazaro Herrera
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem creates a dashboard for monitoring of ongoing CPU/RAM usage
+  of your processes.
+email:
+- lazherrera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/channels/resource_channel.rb
+- app/controllers/resource_controller.rb
+- app/views/resource/index.html.erb
+- bin/setup
+- lib/resource_monitor.rb
+- lib/resource_monitor/railtie.rb
+- lib/resource_monitor/version.rb
+- lib/tasks/rm_console.rake
+- resource_monitor.gemspec
+homepage: http://writecodeeveryday.github.io/projects/resource_monitor
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A Rails 5 ActionCable gem for simple resource usage monitoring.
+test_files: []