munin_passenger 1.0.0

data/lib/munin_passenger/collect.rb

@@ -0,0 +1,71 @@
+require 'nokogiri'
+require 'ostruct'
+
+module MuninPassenger
+  module Collect
+
+    def self.parse_stats(f)
+      Nokogiri::XML(f) do |config|
+        config.strict.
+               noblanks.  # Exclude blank nodes
+               nonet      # Don't make any network connections
+      end
+    end
+
+    def self.get_group_stats(doc)
+      ret = []
+      doc.xpath('//info/supergroups/supergroup').each do |x_supergroup|
+        x_supergroup.xpath('./group').each do |x_group|
+          g = OpenStruct.new
+          g.name = x_group.xpath('name').first.text
+          g.queue = x_group.xpath('get_wait_list_size').first.text
+          ret << g
+        end
+      end
+      ret
+    end
+
+    def self.get_ps_stats(doc)
+      ret = []
+      now = Time.now
+      doc.xpath('//info/supergroups/supergroup').each do |x_supergroup|
+        x_supergroup.xpath('./group').each do |x_group|
+          x_group.xpath('./processes/process').each do |x_ps|
+            ps = OpenStruct.new
+            ps.pid         = x_ps.xpath('pid').first.text
+            ps.sessions    = x_ps.xpath('sessions').first.text.to_i
+            ps.last_used   = (now - Time.at(x_ps.xpath('last_used').first.text.to_i / 1000 / 1000).to_i).to_i # in seconds
+            ps.ram         = x_ps.xpath('real_memory').first.text.to_i   # in KB
+            ps.cpu         = x_ps.xpath('cpu').first.text.to_i           # in %
+            ps.uptime      = (now - Time.at(x_ps.xpath('spawn_start_time').first.text.to_i / 1000 / 1000).to_i).to_i # in seconds
+            ps.processed   = x_ps.xpath('processed').first.text.to_i     # in requests
+            ret << ps
+          end
+        end
+      end
+      ret
+    end
+
+    def self.run_status
+      dir = if ENV['PASSENGER_ROOT']
+              "#{ENV['PASSENGER_ROOT']}/"
+            else
+              ''
+            end
+
+      sudo = if ENV['WITHOUT_SUDO']
+               ''
+             else
+               'sudo '
+             end
+
+      status = `#{sudo}#{dir}passenger-status --show=xml`
+      if not $?.success?
+        $stderr.puts 'Error running passenger-status'
+        exit 1
+      end
+      status
+    end
+
+  end
+end

data/lib/munin_passenger/graphs.rb

@@ -0,0 +1,213 @@
+module MuninPassenger
+  module Graphs
+
+    def self.escape_group(g_name)
+      g_name.gsub(/^[^a-zA-Z_]/, '_').
+        gsub(/[^a-zA-Z0-9_]/, '_')
+    end
+
+    def self.get_stats
+      doc = MuninPassenger::Collect.parse_stats(MuninPassenger::Collect.run_status)
+      groups = MuninPassenger::Collect.get_group_stats(doc)
+      pses = MuninPassenger::Collect.get_ps_stats(doc)
+      [groups, pses]
+    end
+
+    # ###############
+    # passenger_queue
+    # ###############
+
+    def self.queue_config
+      groups, pses = get_stats
+      ret = ''
+      ret += <<-EOF
+graph_category passenger
+graph_title Passenger queue
+graph_vlabel Requests
+      EOF
+      groups.each do |g|
+        ret += <<-EOF
+_group_#{escape_group(g.name)}_queue.label #{g.name}
+        EOF
+      end
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_sessions.label PID #{ps.pid}
+        EOF
+      end
+      ret
+    end
+
+    def self.queue_values
+      groups, pses = get_stats
+      ret = ''
+      groups.each do |g|
+        ret += <<-EOF
+_group_#{escape_group(g.name)}_queue.value #{g.queue}
+    EOF
+      end
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_sessions.value #{ps.sessions}
+        EOF
+      end
+      ret
+    end
+
+    # #############
+    # passenger_ram
+    # #############
+
+    def self.ram_config
+      groups, pses = get_stats
+      ret = ''
+      ret += <<-EOF
+graph_category passenger
+graph_title Passenger memory usage
+graph_vlabel Bytes
+      EOF
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_ram.label PID #{ps.pid}
+        EOF
+      end
+      ret
+    end
+
+    def self.ram_values
+      groups, pses = get_stats
+      ret = ''
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_ram.value #{ps.ram * 1024}
+        EOF
+      end
+      ret
+    end
+
+    # #############
+    # passenger_cpu
+    # #############
+
+    def self.cpu_config
+      groups, pses = get_stats
+      ret = ''
+      ret += <<-EOF
+graph_category passenger
+graph_title Passenger CPU
+graph_vlabel %
+      EOF
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_cpu.label PID #{ps.pid}
+        EOF
+      end
+      ret
+    end
+
+    def self.cpu_values
+      groups, pses = get_stats
+      ret = ''
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_cpu.value #{ps.cpu}
+        EOF
+      end
+      ret
+    end
+
+    # ###################
+    # passenger_processed
+    # ###################
+
+    def self.processed_config
+      groups, pses = get_stats
+      ret = ''
+      ret += <<-EOF
+graph_category passenger
+graph_title Requests processed
+graph_vlabel Requests
+      EOF
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_processed.label PID #{ps.pid}
+        EOF
+      end
+      ret
+    end
+
+    def self.processed_values
+      groups, pses = get_stats
+      ret = ''
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_processed.value #{ps.processed}
+        EOF
+      end
+      ret
+    end
+
+    # ################
+    # passenger_uptime
+    # ################
+
+    def self.uptime_config
+      groups, pses = get_stats
+      ret = ''
+      ret += <<-EOF
+graph_category passenger
+graph_title Uptime
+graph_vlabel Hours
+      EOF
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_uptime.label PID #{ps.pid}
+        EOF
+      end
+      ret
+    end
+
+    def self.uptime_values
+      groups, pses = get_stats
+      ret = ''
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_uptime.value #{ps.uptime.to_f / 60 / 60}
+        EOF
+      end
+      ret
+    end
+
+    # ###################
+    # passenger_last_used
+    # ###################
+
+    def self.last_used_config
+      groups, pses = get_stats
+      ret = ''
+      ret += <<-EOF
+graph_category passenger
+graph_title Last used
+graph_vlabel Seconds
+      EOF
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_last_used.label PID #{ps.pid}
+        EOF
+      end
+      ret
+    end
+
+    def self.last_used_values
+      groups, pses = get_stats
+      ret = ''
+      pses.each do |ps|
+        ret += <<-EOF
+_pid_#{ps.pid}_last_used.value #{ps.last_used}
+        EOF
+      end
+      ret
+    end
+
+  end
+end

data/lib/munin_passenger/version.rb

@@ -0,0 +1,3 @@
+module MuninPassenger
+  VERSION = '1.0.0'
+end

data/lib/munin_passenger.rb

@@ -0,0 +1,2 @@
+require 'munin_passenger/collect'
+require 'munin_passenger/graphs'

data/munin_passenger.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'munin_passenger/version'
+
+Gem::Specification.new do |s|
+  s.name     = "munin_passenger"
+  s.version  = MuninPassenger::VERSION
+  s.platform = Gem::Platform::RUBY
+
+  s.summary     = "Munin plugin for monitoring Phusion Passenger."
+  s.description = "Runs passenger-status to graph CPU, RAM, queue size, requests served, etc."
+
+  s.authors  = ["Paul A. Jungwirth"]
+  s.homepage = "https://github.com/pjungwir/munin_passenger"
+  s.email    = "pj@illuminatedcomputing.com"
+
+  s.licenses = ["MIT"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,fixtures}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}.reject{|f| f =~ /\.sh$/}
+  s.require_paths = ["lib"]
+  s.rdoc_options  = ['--charset=UTF-8']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop'
+
+  s.add_dependency 'nokogiri'
+end
+

data/scripts/capture-passenger-status.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+vagrant ssh -c 'sudo passenger-status --show=xml 2>/dev/null' 2>/dev/null

data/scripts/load-test.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+ab -c 10 -n 10000 http://192.168.60.10/status

data/scripts/make-bins.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+plugins = %w[queue ram cpu processed uptime last_used]
+
+plugins.each do |g|
+  filename = "bin/passenger_#{g}"
+  File.open(filename, 'w') do |f|
+    f.puts <<~EOF
+      #!/usr/bin/env ruby
+
+      require 'munin_passenger'
+
+      if ARGV[0] == 'config'
+        puts MuninPassenger::Graphs.#{g}_config
+      else
+        puts MuninPassenger::Graphs.#{g}_values
+      end
+    EOF
+  end
+  system("chmod +x #{filename}")
+end
+
+filename = "bin/munin_passenger-install.sh"
+File.open(filename, 'w') do |f|
+  f.puts <<~EOF
+    #/bin/bash
+
+    set -eu
+
+    dest="${1:-/etc/munin/plugins/}"
+    mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+  EOF
+  plugins.each do |p|
+    f.puts %Q{ln -fs "${mydir}/passenger_#{p}" "$dest"}
+  end
+end
+system("chmod +x #{filename}")

data/spec/mock/passenger-status

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+puts File.read(File.dirname(__FILE__) + '/passenger-status.xml') {|f| f.read.strip}

data/spec/mock/passenger-status.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="iso8859-1" ?>
+<info version="3"><passenger_version>5.3.4</passenger_version><group_count>1</group_count><process_count>4</process_count><max>4</max><capacity_used>4</capacity_used><get_wait_list_size>0</get_wait_list_size><supergroups><supergroup><name>/vagrant/example &#40;production&#41;</name><state>READY</state><get_wait_list_size>0</get_wait_list_size><capacity_used>4</capacity_used><group default="true"><name>/vagrant/example &#40;production&#41;</name><component_name>/vagrant/example &#40;production&#41;</component_name><app_root>/vagrant/example</app_root><app_type>rack</app_type><environment>production</environment><uuid>HmNUaXddYHxqdbDHhMlH</uuid><enabled_process_count>4</enabled_process_count><disabling_process_count>0</disabling_process_count><disabled_process_count>0</disabled_process_count><capacity_used>4</capacity_used><get_wait_list_size>4</get_wait_list_size><disable_wait_list_size>0</disable_wait_list_size><processes_being_spawned>0</processes_being_spawned><life_status>ALIVE</life_status><user>www-data</user><uid>33</uid><group>www-data</group><gid>33</gid><options><app_root>/vagrant/example</app_root><app_group_name>/vagrant/example &#40;production&#41;</app_group_name><app_type>rack</app_type><start_command>/usr/bin/passenger_free_ruby /usr/share/passenger/helper-scripts/rack-loader.rb</start_command><startup_file>/vagrant/example/config.ru</startup_file><process_title>Passenger RubyApp</process_title><log_level>3</log_level><start_timeout>90000</start_timeout><environment>production</environment><base_uri>/</base_uri><spawn_method>smart</spawn_method><default_user>www-data</default_user><default_group>www-data</default_group><restart_dir>tmp</restart_dir><integration_mode>nginx</integration_mode><ruby>/usr/bin/passenger_free_ruby</ruby><python>python</python><nodejs>node</nodejs><debugger>false</debugger><api_key>SslPEpMlXcKPv4DX</api_key><min_processes>4</min_processes><max_processes>0</max_processes><max_preloader_idle_time>300</max_preloader_idle_time><max_out_of_band_work_instances>1</max_out_of_band_work_instances></options><processes><process><pid>4510</pid><sticky_session_id>1463048305</sticky_session_id><gupid>186d826-q9scApl4BE</gupid><concurrency>1</concurrency><sessions>1</sessions><busyness>2147483647</busyness><processed>139</processed><spawner_creation_time>1536862465405912</spawner_creation_time><spawn_start_time>1536862469897396</spawn_start_time><spawn_end_time>1536862469995617</spawn_end_time><last_used>1536862501524427</last_used><last_used_desc>0s ago</last_used_desc><uptime>32s</uptime><life_status>ALIVE</life_status><enabled>ENABLED</enabled><has_metrics>true</has_metrics><cpu>2</cpu><rss>74332</rss><pss>46755</pss><private_dirty>40400</private_dirty><swap>0</swap><real_memory>40400</real_memory><vmsize>403004</vmsize><process_group_id>4447</process_group_id><command>Passenger AppPreloader: /vagrant/example &#40;forking...&#41;</command></process><process><pid>4529</pid><sticky_session_id>1881688971</sticky_session_id><gupid>186d826-0gXXbEbmmP</gupid><concurrency>1</concurrency><sessions>1</sessions><busyness>2147483647</busyness><processed>138</processed><spawner_creation_time>1536862465405912</spawner_creation_time><spawn_start_time>1536862470006804</spawn_start_time><spawn_end_time>1536862470078273</spawn_end_time><last_used>1536862501513463</last_used><last_used_desc>0s ago</last_used_desc><uptime>31s</uptime><life_status>ALIVE</life_status><enabled>ENABLED</enabled><has_metrics>true</has_metrics><cpu>3</cpu><rss>73824</rss><pss>34705</pss><private_dirty>24396</private_dirty><swap>0</swap><real_memory>24396</real_memory><vmsize>403100</vmsize><process_group_id>4447</process_group_id><command>Passenger AppPreloader: /vagrant/example &#40;forking...&#41;</command></process><process><pid>4548</pid><sticky_session_id>1153287320</sticky_session_id><gupid>186d826-BeArKZIXdV</gupid><concurrency>1</concurrency><sessions>1</sessions><busyness>2147483647</busyness><processed>138</processed><spawner_creation_time>1536862465405912</spawner_creation_time><spawn_start_time>1536862470085976</spawn_start_time><spawn_end_time>1536862470135512</spawn_end_time><last_used>1536862501526424</last_used><last_used_desc>0s ago</last_used_desc><uptime>31s</uptime><life_status>ALIVE</life_status><enabled>ENABLED</enabled><has_metrics>true</has_metrics><cpu>2</cpu><rss>73836</rss><pss>34607</pss><private_dirty>24268</private_dirty><swap>0</swap><real_memory>24268</real_memory><vmsize>403196</vmsize><process_group_id>4447</process_group_id><command>Passenger AppPreloader: /vagrant/example &#40;forking...&#41;</command></process><process><pid>4567</pid><sticky_session_id>929143326</sticky_session_id><gupid>186d826-Gf2fJwkxHL</gupid><concurrency>1</concurrency><sessions>1</sessions><busyness>2147483647</busyness><processed>138</processed><spawner_creation_time>1536862465405912</spawner_creation_time><spawn_start_time>1536862470144900</spawn_start_time><spawn_end_time>1536862470218102</spawn_end_time><last_used>1536862501522542</last_used><last_used_desc>0s ago</last_used_desc><uptime>31s</uptime><life_status>ALIVE</life_status><enabled>ENABLED</enabled><has_metrics>true</has_metrics><cpu>2</cpu><rss>73848</rss><pss>34428</pss><private_dirty>23872</private_dirty><swap>0</swap><real_memory>23872</real_memory><vmsize>403292</vmsize><process_group_id>4447</process_group_id><command>Passenger AppPreloader: /vagrant/example &#40;forking...&#41;</command></process></processes></group></supergroup></supergroups></info>

data/spec/munin_passenger_spec.rb

@@ -0,0 +1,139 @@
+describe 'munin_passenger plugin' do
+
+  before do
+    ENV['PASSENGER_ROOT'] = File.dirname(__FILE__) + '/mock'
+  end
+
+  it "gives the queue configuration" do
+    expect(MuninPassenger::Graphs.queue_config).to eq <<-EOF
+graph_category passenger
+graph_title Passenger queue
+graph_vlabel Requests
+_group__vagrant_example__production__queue.label /vagrant/example (production)
+_pid_4510_sessions.label PID 4510
+_pid_4529_sessions.label PID 4529
+_pid_4548_sessions.label PID 4548
+_pid_4567_sessions.label PID 4567
+    EOF
+  end
+
+  it "gives the queue values" do
+    expect(MuninPassenger::Graphs.queue_values).to eq <<-EOF
+_group__vagrant_example__production__queue.value 4
+_pid_4510_sessions.value 1
+_pid_4529_sessions.value 1
+_pid_4548_sessions.value 1
+_pid_4567_sessions.value 1
+    EOF
+  end
+
+  it "gives the ram configuration" do
+    expect(MuninPassenger::Graphs.ram_config).to eq <<-EOF
+graph_category passenger
+graph_title Passenger memory usage
+graph_vlabel Bytes
+_pid_4510_ram.label PID 4510
+_pid_4529_ram.label PID 4529
+_pid_4548_ram.label PID 4548
+_pid_4567_ram.label PID 4567
+    EOF
+  end
+
+  it "gives the ram values" do
+    expect(MuninPassenger::Graphs.ram_values).to eq <<-EOF
+_pid_4510_ram.value #{40400 * 1024}
+_pid_4529_ram.value #{24396 * 1024}
+_pid_4548_ram.value #{24268 * 1024}
+_pid_4567_ram.value #{23872 * 1024}
+    EOF
+  end
+
+  it "gives the cpu configuration" do
+    expect(MuninPassenger::Graphs.cpu_config).to eq <<-EOF
+graph_category passenger
+graph_title Passenger CPU
+graph_vlabel %
+_pid_4510_cpu.label PID 4510
+_pid_4529_cpu.label PID 4529
+_pid_4548_cpu.label PID 4548
+_pid_4567_cpu.label PID 4567
+    EOF
+  end
+
+  it "gives the cpu values" do
+    expect(MuninPassenger::Graphs.cpu_values).to eq <<-EOF
+_pid_4510_cpu.value 2
+_pid_4529_cpu.value 3
+_pid_4548_cpu.value 2
+_pid_4567_cpu.value 2
+    EOF
+  end
+
+  it "gives the processed configuration" do
+    expect(MuninPassenger::Graphs.processed_config).to eq <<-EOF
+graph_category passenger
+graph_title Requests processed
+graph_vlabel Requests
+_pid_4510_processed.label PID 4510
+_pid_4529_processed.label PID 4529
+_pid_4548_processed.label PID 4548
+_pid_4567_processed.label PID 4567
+    EOF
+  end
+
+  it "gives the processed values" do
+    expect(MuninPassenger::Graphs.processed_values).to eq <<-EOF
+_pid_4510_processed.value 139
+_pid_4529_processed.value 138
+_pid_4548_processed.value 138
+_pid_4567_processed.value 138
+    EOF
+  end
+
+  it "gives the uptime configuration" do
+    expect(MuninPassenger::Graphs.uptime_config).to eq <<-EOF
+graph_category passenger
+graph_title Uptime
+graph_vlabel Hours
+_pid_4510_uptime.label PID 4510
+_pid_4529_uptime.label PID 4529
+_pid_4548_uptime.label PID 4548
+_pid_4567_uptime.label PID 4567
+    EOF
+  end
+
+  it "gives the uptime values" do
+    Timecop.travel('Thu Sep 13 20:36:38 PDT 2018') do
+      expect(MuninPassenger::Graphs.uptime_values).to eq <<-EOF
+_pid_4510_uptime.value 9.369166666666667
+_pid_4529_uptime.value 9.368888888888888
+_pid_4548_uptime.value 9.368888888888888
+_pid_4567_uptime.value 9.368888888888888
+      EOF
+    end
+  end
+
+  it "gives the last_used configuration" do
+    expect(MuninPassenger::Graphs.last_used_config).to eq <<-EOF
+graph_category passenger
+graph_title Last used
+graph_vlabel Seconds
+_pid_4510_last_used.label PID 4510
+_pid_4529_last_used.label PID 4529
+_pid_4548_last_used.label PID 4548
+_pid_4567_last_used.label PID 4567
+    EOF
+  end
+
+  it "gives the last_used values" do
+    Timecop.travel('Thu Sep 13 20:36:38 PDT 2018') do
+      expect(MuninPassenger::Graphs.last_used_values).to eq <<-EOF
+_pid_4510_last_used.value 33697
+_pid_4529_last_used.value 33697
+_pid_4548_last_used.value 33697
+_pid_4567_last_used.value 33697
+      EOF
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter %r{^/spec/}
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rspec/matchers'
+require 'munin_passenger'
+require 'timecop'
+
+RSpec.configure do |config|
+
+end