resource_monitor 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 32aa3a39198facc9dc8a8a7d841922e8bdbfd539
4
+ data.tar.gz: 64ece18593944af62e3c625eff499b6c885648e9
5
+ SHA512:
6
+ metadata.gz: 30e746e4f8a0e04d2b799b6d95769653daa7a8e80abcab0220def11d103cc8cf6985f61ee7de3ef4af87ce276959ff096bc43015e5f03eda6571d89946a8e4a3
7
+ data.tar.gz: 410394aef801e12c85a6ac220dffe4c51b183a029c93ed7281281a9ae2262b3cdd373e74200be35cbf9eb8206bd76a17763e0ac12a339dfff037ee7d12c80f90
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at lazherrera@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in resource_monitor.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Lazaro Herrera
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,89 @@
1
+ # ResourceMonitor
2
+
3
+ This is a simple rails resource monitoring gem.
4
+
5
+ Requires ActionCable and Rails 5.0+, and is optimized to run under Linux / Mac servers.
6
+
7
+ Creates a simple page under /resources/ that is updated with CPU/RAM usage in realtime.
8
+
9
+ 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.
10
+
11
+ Current Project Status: Usable
12
+
13
+ ## Installation
14
+
15
+ Add this line to your application's Gemfile:
16
+
17
+ ```ruby
18
+ gem 'resource_monitor'
19
+ ```
20
+
21
+ And then execute:
22
+
23
+ $ bundle install
24
+
25
+ This following line will add a set of views/controllers/and channels into your app.
26
+
27
+ $ rake resource_monitor:install_dashboard
28
+
29
+ And then add the following to the top of your application.rb file
30
+ You can also only add it to the controllers you think may be causing some issues.
31
+
32
+ ```ruby
33
+ before_action :resource_monitor_app
34
+ after_action :resource_monitor_app
35
+
36
+ def resource_monitor_app
37
+ ResourceMonitor.benchmark(self)
38
+ end
39
+ ```
40
+
41
+ ## Uninstall
42
+
43
+ If you added the dashboard to your project, you can remove it using this.
44
+
45
+ $ rake resource_monitor:uninstall_dashboard
46
+
47
+ This will leave behind a "resource" folder in your views but it's less risky than removing folders from your views folder.
48
+
49
+ ## Usage
50
+
51
+ You can try out the gem by using
52
+
53
+ $ rake resource_monitor:console
54
+
55
+ Once inside irb, you can use the following
56
+
57
+ ```ruby
58
+ ResourceMonitor.benchmark(self)
59
+ ```
60
+
61
+ Install the dashboard, deploy and browse to /resources/.
62
+
63
+ 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.
64
+
65
+ ```ruby
66
+ before_action :resource_monitor_app
67
+ after_action :resource_monitor_app
68
+
69
+ def resource_monitor_app
70
+ if ENV['MONITORING_ENABLED']
71
+ ResourceMonitor.benchmark(self)
72
+ end
73
+ end
74
+ ```
75
+
76
+ ## Development
77
+
78
+ 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.
79
+
80
+ 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).
81
+
82
+ ## Contributing
83
+
84
+ Bug reports and pull requests are welcome on GitHub at https://github.com/WriteCodeEveryday/resource_monitor.
85
+
86
+
87
+ ## License
88
+
89
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+ Dir.glob('lib/tasks/*.rake').each {|r| import r}
@@ -0,0 +1,6 @@
1
+ class ResourceChannel < ApplicationCable::Channel
2
+ def subscribed
3
+ stream_from "resources"
4
+ ResourceMonitor.benchmark()
5
+ end
6
+ end
@@ -0,0 +1,5 @@
1
+ class ResourceController < ApplicationController
2
+ def index
3
+ render layout: false
4
+ end
5
+ end
@@ -0,0 +1,79 @@
1
+ <html>
2
+ <head></head>
3
+ <body>
4
+ <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
5
+ <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
6
+ <link href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
7
+ <script>
8
+ App.cable = ActionCable.createConsumer("//<%= request.host_with_port %>/cable");
9
+ //App.cable = ActionCable.createConsumer("ws://localhost:3000/websocket");
10
+ App.data = App.cable.subscriptions.create({ channel: "ResourceChannel" }, {
11
+ received: function(data) {
12
+ var json = JSON.parse(data)
13
+ var process_id = json['process_id']
14
+ var cpu_percentage = json['cpu_percentage']
15
+ var ram_percentage = json['ram_percentage']
16
+ var ram_usage = json['ram_usage']
17
+ var last_executed_controller = json['last_executed_controller']
18
+ var last_executed_action = json['last_executed_action']
19
+
20
+
21
+ var execution_details_td = jQuery('<td/>', {
22
+ text: ""
23
+ });
24
+
25
+ var controller_details = jQuery('<p>',{
26
+ text: "Controller: " +last_executed_controller
27
+ })
28
+
29
+ var action_details = jQuery('<p>',{
30
+ text: "Action: " + last_executed_action
31
+ })
32
+
33
+ var ram_usage_td = jQuery('<td/>', {
34
+ text: ram_usage + " MB"
35
+ });
36
+
37
+ var ram_percentage_td= jQuery('<td/>', {
38
+ text: ram_percentage + "%"
39
+ });
40
+
41
+ var cpu_percentage_td= jQuery('<td/>', {
42
+ text: cpu_percentage + "%"
43
+ });
44
+
45
+ var process_id_td = jQuery('<td/>', {
46
+ text: process_id
47
+ });
48
+
49
+ var main_tr = $('<tr></tr>')
50
+ var table_body = $("#table_body")
51
+ process_id_td.appendTo(main_tr)
52
+ cpu_percentage_td.appendTo(main_tr)
53
+ ram_percentage_td.appendTo(main_tr)
54
+ ram_usage_td.appendTo(main_tr)
55
+ controller_details.appendTo(execution_details_td)
56
+ action_details.appendTo(execution_details_td)
57
+ execution_details_td.appendTo(main_tr)
58
+ main_tr.prependTo(table_body)
59
+ }
60
+ });
61
+ </script>
62
+ <div id="holder" class="container">
63
+ <h2>ResourceMonitorDashboard</h2>
64
+ <table class="table table-striped">
65
+ <thead>
66
+ <tr>
67
+ <th>Process ID</th>
68
+ <th>CPU Percentage</th>
69
+ <th>RAM Percentage</th>
70
+ <th>RAM Usage (MB)</th>
71
+ <th>Execution Details</th>
72
+ </tr>
73
+ </thead>
74
+ <tbody id="table_body">
75
+ </tbody>
76
+ </table>
77
+ </div>
78
+ </body>
79
+ </html>
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,29 @@
1
+ require "resource_monitor/version"
2
+ require "resource_monitor/railtie" if defined?(Rails)
3
+
4
+ module ResourceMonitor
5
+ def self.benchmark(controller=nil)
6
+ # Recover the process id and memory usage in KB (http://stackoverflow.com/questions/7220896/get-current-ruby-process-memory-usage)
7
+ pid, size, cpu_per, mem_per = `ps ax -o pid,rss,%cpu,%mem | grep -E "^[[:space:]]*#{$$}"`.strip.split.map(&:to_i)
8
+
9
+ if defined?(Rails)
10
+ last_executed_controller = controller&.controller_name&.presence || controller&['controller_name']&.presence || 'NoController'
11
+ last_executed_action = controller&.action_name&.presence || controller&['action_name']&.presence || 'NoAction'
12
+ else
13
+ last_executed_controller = controller&.controller_name || 'NoController'
14
+ last_executed_action = controller&.action_name || 'NoAction'
15
+ end
16
+
17
+ data = {
18
+ process_id: pid,
19
+ cpu_percentage: cpu_per,
20
+ ram_percentage: mem_per,
21
+ ram_usage: (size / 1024).to_i,
22
+ last_executed_controller: last_executed_controller,
23
+ last_executed_action: last_executed_action
24
+ }
25
+
26
+ ActionCable.server.broadcast 'resources', data.to_json if defined?(ActionCable)
27
+ return data
28
+ end
29
+ end
@@ -0,0 +1,5 @@
1
+ class ResourceMonitor::Railtie < Rails::Railtie
2
+ rake_tasks do
3
+ load 'tasks/rm_console.rake'
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module ResourceMonitor
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,39 @@
1
+ namespace :resource_monitor do
2
+ # Works perfectly as a quick test environment.
3
+ task :console do
4
+ require 'irb'
5
+ require 'irb/completion'
6
+ require 'resource_monitor' # You know what to do.
7
+ ARGV.clear
8
+ IRB.start
9
+ end
10
+
11
+ # Works correctly.
12
+ task :install_dashboard do
13
+ if defined?(Rails)
14
+ path = Gem.loaded_specs['resource_monitor'].full_gem_path
15
+ puts "Copying from #{path}/app/ to #{Rails.root.to_s}/app/"
16
+ FileUtils.cp_r "#{path}/app/.", "#{Rails.root.to_s}/app/"
17
+ puts "IMPORTANT: Remember to add the following route to your config/routes.rb"
18
+ puts "get '/resources/' => 'resource#index'"
19
+ else
20
+ puts "This installer should be run inside a Rails project."
21
+ end
22
+ end
23
+
24
+ # Does nothing at all.
25
+ task :uninstall_dashboard do
26
+ if defined?(Rails)
27
+ path = Gem.loaded_specs['resource_monitor'].full_gem_path
28
+ records = Dir.glob("#{path}/app/**/**").select { |f| File.file?(f) }
29
+ records.each do |item|
30
+ puts "Removing #{Rails.root.to_s}#{item.split(path)[1]}"
31
+ FileUtils.rm "#{Rails.root.to_s}#{item.split(path)[1]}"
32
+ end
33
+ puts "IMPORTANT: Remember to remove the following route from your config/routes.rb"
34
+ puts "get '/resources/' => 'resource#index'"
35
+ else
36
+ puts "This uninstaller should be run inside a Rails project."
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'resource_monitor/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "resource_monitor"
8
+ spec.version = ResourceMonitor::VERSION
9
+ spec.authors = ["Lazaro Herrera"]
10
+ spec.email = ["lazherrera@gmail.com"]
11
+
12
+ spec.summary = %q{A Rails 5 ActionCable gem for simple resource usage monitoring.}
13
+ spec.description = %q{This gem creates a dashboard for monitoring of ongoing CPU/RAM usage of your processes.}
14
+ spec.homepage = "http://writecodeeveryday.github.io/projects/resource_monitor"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.14"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "actioncable"
27
+ end
metadata ADDED
@@ -0,0 +1,102 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: resource_monitor
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Lazaro Herrera
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-04-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: actioncable
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: This gem creates a dashboard for monitoring of ongoing CPU/RAM usage
56
+ of your processes.
57
+ email:
58
+ - lazherrera@gmail.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - CODE_OF_CONDUCT.md
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - app/channels/resource_channel.rb
70
+ - app/controllers/resource_controller.rb
71
+ - app/views/resource/index.html.erb
72
+ - bin/setup
73
+ - lib/resource_monitor.rb
74
+ - lib/resource_monitor/railtie.rb
75
+ - lib/resource_monitor/version.rb
76
+ - lib/tasks/rm_console.rake
77
+ - resource_monitor.gemspec
78
+ homepage: http://writecodeeveryday.github.io/projects/resource_monitor
79
+ licenses:
80
+ - MIT
81
+ metadata: {}
82
+ post_install_message:
83
+ rdoc_options: []
84
+ require_paths:
85
+ - lib
86
+ required_ruby_version: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ">="
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ required_rubygems_version: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: '0'
96
+ requirements: []
97
+ rubyforge_project:
98
+ rubygems_version: 2.6.11
99
+ signing_key:
100
+ specification_version: 4
101
+ summary: A Rails 5 ActionCable gem for simple resource usage monitoring.
102
+ test_files: []