munin_passenger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd4851916ebee9fa861409169457d111a73ffd2ba8601f94baac9656be2df3d5
+  data.tar.gz: 5d65009a959ae947020602d57a84d97e7464f604cc0be371285a99177f357dd1
+SHA512:
+  metadata.gz: 699faab7cf106fbd9243e0ab513ba43a7f78479f3dfcdedefab1f88364aa863eb360eaeb2d0dbc6f12d5521178a4463b6113c61642919e6af2941146cc7334fb
+  data.tar.gz: 6467c039f53a061b6d4324c2b79b09eac0a32c8678f0933d31a05c130690bb9ede1852d90b3011a8f28e2c7e2b3ab1d62df4ef778041c07044b983a6e165704c

data/.gitignore

@@ -0,0 +1,11 @@
+/.vagrant
+*.log
+/coverage
+/rdoc
+/doc
+/pkg
+/tmp
+/README.html
+/.ruby-version
+/.ruby-gemset
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - jruby
+
+matrix:
+  include:
+  # Only run rubocop on the latest Ruby:
+  - rvm: 2.5
+    env: SUITE="rubocop"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Paul A. Jungwirth
+
+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,69 @@
+This is a collection of [munin](http://munin-monitoring.org/) plugins for [Phusion Passenger](https://www.phusionpassenger.com/).
+
+They give you graphs for things like:
+
+- How many requests are waiting in the queue for a worker.
+- How many requests each worker is currently handling.
+- How much RAM each Passenger worker is using.
+- How much CPU each Passenger worker is using.
+- How many cumulative requests have been processed by each worker.
+- How long each worker has been alive.
+- How long each worker has been idle.
+
+The plugins are written in Ruby and packaged as a gem,
+because if you're running Passenger, presumably you are comfortable with Ruby and its ecosystem.
+To install them, first install the gem, then add symlinks to your munin `plugins` directory as desired.
+You can run this to symlink all the plugins automatically:
+
+```
+munin_passenger-install /etc/munin/plugins
+```
+
+(Actually `/etc/munin/plugins` if the default, so you can leave it off if you like.)
+
+You should also configure the plugins by adding a file at `/etc/munin/plugin-conf.d/passenger` with these contents:
+
+```
+[passenger_*]
+user root
+env.PASSENGER_ROOT /usr/sbin
+```
+
+The `user root` line is necessary because otherwise `passenger-status` will refuse to run.
+The second line should be whatever directory contains `passenger-status`.
+
+Once installed, you will get graphs for most of the things `passenger-status` can tell you.
+
+# TODO
+
+- Distinguish between different groups/supergroups, perhaps by having plugins like `passenger_ram_` etc.
+  so you can get them in separate graphs.
+
+- Suppress the "helpful" `passenger-status` message about `xmllint` so it doesn't clutter the munin log,
+  without suppressing all the rest of stderr.
+
+# Development
+
+You can run tests by saying `rspec spec`.
+
+You can build a local copy of the gem by saying `rake build`, and install it with `rake install`.
+
+After running `rake build`
+you can run `vagrant up` to build a machine running Passenger against a dummy Rails app,
+with this munin plugin included.
+It will install the most recent `*.gem` file in `pkg`.
+Then you can do to http://192.168.60.10:7778/ to see the graphs.
+
+You can run `scripts/make-bins.rb` to regenerate the files in `bin`.
+
+You can run `scripts/load-test.sh` to simulate load on the app.
+While that is running, do `scripts/capture-passenger-status.sh` to get some realish XML you can use as a test fixture or example.
+
+If you have it installed, you can use `xmllint --format -` and `xmllint --noblanks -` to make Passenger's XML readable vs compact.
+
+You can release a new version of the gem with `rake release`.
+
+# Copyright
+
+Copyright (c) 2018 by Paul A. Jungwirth.
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task readme: [] do
+  `markdown README.md >README.html`
+end
+
+if ENV['CI'].nil?
+  task default: %w[spec rubocop]
+else
+  case ENV['SUITE']
+  when 'rubocop' then task default: :rubocop
+  else                task default: :spec
+  end
+end

data/Vagrantfile

@@ -0,0 +1,172 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  # All Vagrant configuration is done here. The most common configuration
+  # options are documented and commented below. For a complete reference,
+  # please see the online documentation at vagrantup.com.
+
+  # Every Vagrant virtual environment requires a box to build off of.
+  config.vm.box = "ubuntu/xenial64"
+  # config.vm.box_version = '0.1.0'
+
+  config.ssh.forward_agent = true
+  config.omnibus.chef_version = '12.18.31'
+
+  config.vm.define "app" do |host|
+    host.vm.network :private_network, ip: "192.168.60.10"
+    host.vm.provider :virtualbox do |vb|
+      vb.name = "munin_with_passenger"
+      vb.customize ["modifyvm", :id, "--memory", "1024"]
+    end
+  end
+
+  config.vm.provision :shell, inline: <<-EOS
+set -eu
+
+sudo apt-get update
+
+# nginx
+sudo apt-get install -y nginx
+
+# passenger
+sudo apt-get install -y dirmngr gnupg
+sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 561F9B9CAC40B2F7
+sudo apt-get install -y apt-transport-https ca-certificates
+sudo sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger xenial main > /etc/apt/sources.list.d/passenger.list'
+sudo apt-get update
+sudo apt-get install -y nginx-extras passenger
+sudo tee /etc/nginx/nginx.conf <<EOF
+user www-data;
+worker_processes 2;
+pid /run/nginx.pid;
+
+events {
+  worker_connections 768;
+}
+
+http {
+  sendfile on;
+  tcp_nopush on;
+  tcp_nodelay on;
+  keepalive_timeout 65;
+  types_hash_max_size 2048;
+  # server_tokens off;
+
+  # server_names_hash_bucket_size 64;
+  # server_name_in_redirect off;
+
+  include /etc/nginx/mime.types;
+  default_type application/octet-stream;
+
+  ##
+  # SSL Settings
+  ##
+
+  ssl_protocols TLSv1 TLSv1.1 TLSv1.2; # Dropping SSLv3, ref: POODLE
+  ssl_prefer_server_ciphers on;
+
+  ##
+  # Logging Settings
+  ##
+
+  access_log /var/log/nginx/access.log;
+  error_log /var/log/nginx/error.log;
+
+  ##
+  # Gzip Settings
+  ##
+
+  gzip on;
+  gzip_disable "msie6";
+
+  # gzip_vary on;
+  # gzip_proxied any;
+  # gzip_comp_level 6;
+  # gzip_buffers 16 8k;
+  # gzip_http_version 1.1;
+  # gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;
+
+  ##
+  # Phusion Passenger config
+  ##
+  # Uncomment it if you installed passenger or passenger-enterprise
+  ##
+
+  include /etc/nginx/passenger.conf;
+  passenger_max_pool_size 4;
+  passenger_pool_idle_time 300;
+  passenger_pre_start http://127.0.0.1/;
+  passenger_user_switching off;
+  passenger_default_user www-data;
+  passenger_default_group www-data;
+
+  limit_req_zone \\$binary_remote_addr zone=one:10m rate=20r/s;
+
+  ##
+  # Virtual Host Configs
+  ##
+
+  include /etc/nginx/conf.d/*.conf;
+  include /etc/nginx/sites-enabled/*;
+}
+EOF
+
+sudo tee /etc/nginx/sites-available/rails <<EOF
+server {
+  listen 80 default_server;
+  server_name _;
+
+  root /vagrant/example/public;
+  try_files \\$uri @passenger;
+
+  location @passenger {
+    rails_env production;
+    passenger_enabled on;
+    passenger_min_instances 4;
+    limit_req zone=one burst=5;
+  }
+}
+EOF
+sudo rm -f /etc/nginx/sites-enabled/default
+sudo ln -s /etc/nginx/sites-available/rails /etc/nginx/sites-enabled/
+
+# munin
+sudo add-apt-repository -y ppa:hawq/munin
+sudo apt-get update
+sudo apt-get install -y munin munin-node
+sudo tee /etc/nginx/sites-available/munin <<EOF
+server {
+  listen 7778;
+  root /var/cache/munin/www;
+}
+EOF
+sudo ln -s /etc/nginx/sites-available/munin /etc/nginx/sites-enabled/
+
+# postgres
+sudo apt-get install -y postgresql postgresql-contrib
+sudo su - postgres -c "psql -c \\"CREATE USER rails WITH PASSWORD 'rails';\\""
+sudo su - postgres -c "psql -c \\"CREATE DATABASE rails WITH OWNER rails;\\""
+
+# rails
+cd /vagrant/example
+sudo gem install bundler
+sudo apt-get install -y build-essential patch ruby-dev zlib1g-dev liblzma-dev libpq-dev nodejs
+sudo bundle install --system
+RAILS_ENV=production bundle exec rake db:migrate
+
+# my plugin
+the_gem=`ls -t /vagrant/pkg/*.gem | head -1`
+if [ ! -z "$the_gem" ]; then
+  sudo gem install /vagrant/pkg/`ls /vagrant/pkg/ | head -1`
+fi
+sudo munin_passenger-install
+sudo tee /etc/munin/plugin-conf.d/passenger <<EOF
+[passenger_*]
+user root
+env.PASSENGER_ROOT /usr/sbin
+EOF
+sudo service munin-node restart
+sudo service nginx restart
+  EOS
+end

data/bin/munin_passenger-install

@@ -0,0 +1,10 @@
+#/usr/bin/env ruby
+
+# This has to be a Ruby script, not a shell script!
+# See https://stackoverflow.com/questions/23701726/deploy-a-shell-script-with-ruby-gem-and-install-in-bin-directory
+
+bin_dir = File.expand_path(File.dirname(__FILE__))
+shell_script_path = File.join(bin_dir, 'munin_passenger-install.sh')
+
+# Have to make sure it runs bash, not dash or sh:
+system("bash", shell_script_path, *ARGV)

data/bin/munin_passenger-install.sh

@@ -0,0 +1,13 @@
+#/bin/bash
+
+set -eu
+
+dest="${1:-/etc/munin/plugins/}"
+mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+ln -fs "${mydir}/passenger_queue" "$dest"
+ln -fs "${mydir}/passenger_ram" "$dest"
+ln -fs "${mydir}/passenger_cpu" "$dest"
+ln -fs "${mydir}/passenger_processed" "$dest"
+ln -fs "${mydir}/passenger_uptime" "$dest"
+ln -fs "${mydir}/passenger_last_used" "$dest"

data/bin/passenger_cpu

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'munin_passenger'
+
+if ARGV[0] == 'config'
+  puts MuninPassenger::Graphs.cpu_config
+else
+  puts MuninPassenger::Graphs.cpu_values
+end

data/bin/passenger_last_used

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'munin_passenger'
+
+if ARGV[0] == 'config'
+  puts MuninPassenger::Graphs.last_used_config
+else
+  puts MuninPassenger::Graphs.last_used_values
+end

data/bin/passenger_munin-install.sh

@@ -0,0 +1,13 @@
+#/bin/bash
+
+set -eu
+
+dest="${1:-/etc/munin/plugins/}"
+mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+ln -s "${mydir}/passenger_queue" "$dest"
+ln -s "${mydir}/passenger_ram" "$dest"
+ln -s "${mydir}/passenger_cpu" "$dest"
+ln -s "${mydir}/passenger_processed" "$dest"
+ln -s "${mydir}/passenger_uptime" "$dest"
+ln -s "${mydir}/passenger_last_used" "$dest"

data/bin/passenger_processed

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'munin_passenger'
+
+if ARGV[0] == 'config'
+  puts MuninPassenger::Graphs.processed_config
+else
+  puts MuninPassenger::Graphs.processed_values
+end

data/bin/passenger_queue

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'munin_passenger'
+
+if ARGV[0] == 'config'
+  puts MuninPassenger::Graphs.queue_config
+else
+  puts MuninPassenger::Graphs.queue_values
+end

data/bin/passenger_ram

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'munin_passenger'
+
+if ARGV[0] == 'config'
+  puts MuninPassenger::Graphs.ram_config
+else
+  puts MuninPassenger::Graphs.ram_values
+end

data/bin/passenger_uptime

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'munin_passenger'
+
+if ARGV[0] == 'config'
+  puts MuninPassenger::Graphs.uptime_config
+else
+  puts MuninPassenger::Graphs.uptime_values
+end

data/example/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+/node_modules
+/yarn-error.log
+
+.byebug_history

data/example/Gemfile

@@ -0,0 +1,45 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+
+gem 'rails', '~> 5.1.6'
+gem 'pg'
+gem 'puma', '~> 3.7'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+gem 'therubyracer', platforms: :ruby
+
+gem 'turbolinks', '~> 5'
+gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '~> 2.13'
+  gem 'selenium-webdriver'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]