rack-server_status 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 209c13022051ab963d2d09b2f8d4a3ab0fed32cc
+  data.tar.gz: f4a25b58e4fbc5ca1ac07cef73db09a1c8eebf8d
+SHA512:
+  metadata.gz: fd93772d4765b43c4a8e8ca023e24655e82d020b62044301dd4ff73779585a3ae212aa56388515eae03b8571b42f9159cb28b92ad29ef5eb4563dd51f52930ad
+  data.tar.gz: 68230a7f8a284f521f0e7a1abf0bbc65328b3ad818e58d02bd6faea5209b350966db6f03a580248fe0efc211495c8949da2cf7f0042a5d19671fa08eb1691d4c

data/.consolerc

@@ -0,0 +1,3 @@
+# This file is automatically loaded when `bundle console` is run. You can add
+# fixtures and/or initialization code here to make experimenting with your gem
+# easier.

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-server_status.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end
+group :test do
+  gem 'rack'
+  gem 'timecop'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright 2015 SpringMT
+
+MIT License
+
+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,31 @@
+# Rack::ServerStatus [![Build Status](https://travis-ci.org/SpringMT/rack-server_status.svg?branch=master)](https://travis-ci.org/SpringMT/rack-server_status)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-server_status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-server_status
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack-server_status/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/rack/server_status/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class ServerStatus
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/server_status.rb

@@ -0,0 +1,143 @@
+require 'rack/server_status/version'
+require 'json'
+require 'worker_scoreboard'
+
+module Rack
+  class ServerStatus
+    def initialize(app, options = {})
+      @app             = app
+      @uptime          = Time.now.to_i
+      @skip_ps_command = options[:skip_ps_command] || false
+      @path            = options[:path]            || '/server-status'
+      @allow           = options[:allow] || []
+      scoreboard_path  = options[:scoreboard_path]
+      unless scoreboard_path.nil?
+        @scoreboard = WorkerScoreboard.new(scoreboard_path)
+      end
+    end
+
+    def call(env)
+      set_state!('A', env)
+
+      @clean_proc = Remover.new
+      ObjectSpace.define_finalizer(self, @clean_proc)
+
+      if @path && env['PATH_INFO'] == @path
+        res = handle_server_status(env)
+        return res
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def set_state!(status = '_', env)
+      return if @scoreboard.nil?
+      prev = {}
+      unless env.nil?
+        prev = {
+          remote_addr: env['REMOTE_ADDR'],
+          host:        env['HTTP_HOST'] || '-',
+          method:      env['REQUEST_METHOD'],
+          uri:         env['REQUEST_URI'],
+          protocol:    env['SERVER_PROTOCOL'],
+          time:        Time.now.to_i
+        }
+      end
+      prev[:pid]    = Process.pid
+      prev[:ppid]   = Process.ppid
+      prev[:uptime] = @uptime
+      prev[:status] = status
+
+      @scoreboard.update(prev.to_json)
+    end
+
+    def allowed?(address)
+      return true if @allow.empty?
+      @allow.include?(address)
+    end
+
+    def handle_server_status(env)
+      unless allowed?(env['REMOTE_ADDR'])
+        return [403, {'Content-Type' => 'text/plain'}, [ 'Forbidden' ]]
+      end
+
+      upsince = Time.now.to_i - @uptime
+      duration = "#{upsince} seconds"
+      body = "Uptime: #{@uptime} (#{duration})\n"
+      status = {Uptime: @uptime}
+
+      unless @scoreboard.nil?
+        stats = @scoreboard.read_all
+        parent_pid = Process.ppid
+        all_workers = []
+        idle = 0
+        busy = 0
+        if @skip_ps_command
+          all_workers = stats.keys
+        elsif RUBY_PLATFORM =~/mswin(?!ce)|mingw|cygwin|bccwin/
+          ps = `LC_ALL=C command ps -e -o ppid,pid`
+          ps.each_line do |line|
+            line.lstrip!
+            next if line =~ /^\D/
+            ppid, pid = line.chmop.split(/\s+/, 2)
+            all_workers << pid.to_i if ppid.to_i == parent_pid
+          end
+        else
+          all_workers = stats.keys
+        end
+        process_status_str = ''
+        process_status_list = []
+
+        all_workers.each do |pid|
+          json =stats[pid] || '{}'
+          pstatus = begin; JSON.parse(json, symbolize_names: true); rescue; end
+          pstatus ||= {}
+          if !pstatus[:status].nil? && pstatus[:status] == 'A'
+            busy += 1
+          else
+            idle += 1
+          end
+          unless pstatus[:time].nil?
+            pstatus[:ss] = Time.now.to_i - pstatus[:time].to_i
+          end
+          pstatus[:pid] ||= pid
+          pstatus.delete :time
+          pstatus.delete :ppid
+          pstatus.delete :uptime
+          process_status_str << sprintf("%s\n", [:pid, :status, :remote_addr, :host, :method, :uri, :protocol, :ss].map {|item| pstatus[item] || '' }.join(' '))
+          process_status_list << pstatus
+        end
+        body << <<"EOF"
+BusyWorkers: #{busy}
+IdleWorkers: #{idle}
+--
+pid status remote_addr host method uri protocol ss
+#{process_status_str}
+EOF
+        body.chomp!
+        status[:BusyWorkers] = busy
+        status[:IdleWorkers] = idle
+        status[:stats]       = process_status_list
+      else
+        body << "WARN: Scoreboard has been disabled\n"
+        status[:WARN] = 'Scoreboard has been disabled'
+      end
+      if (env['QUERY_STRING'] || '') =~ /\bjson\b/
+        return [200, {'Content-Type' => 'application/json; charset=utf-8'}, [status.to_json]]
+      end
+      return [200, {'Content-Type' => 'text/plain'}, [body]]
+    end
+
+    class Remover
+      def initialize
+      end
+      def call(*args)
+        set_state!('_')
+      end
+    end
+
+  end
+
+end

data/rack-server_status.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/server_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-server_status"
+  spec.version       = Rack::ServerStatus::VERSION
+  spec.authors       = ["SpringMT"]
+  spec.email         = ["today.is.sky.blue.sky@gmail.com"]
+
+  #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  spec.required_rubygems_version = ">= 2.0"
+
+  spec.summary       = %q{Show server status}
+  spec.description   = %q{Show server status}
+  spec.homepage      = "https://github.com/SpringMT/rack-server_status"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "worker_scoreboard"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+end

data/spec/server_status_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Rack::ServerStatus do
+  app = lambda { |env|
+    [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]]
+  }
+
+  context 'confirm to Rack::Lint' do
+    context 'Not affected WorkerScoreboard' do
+      subject do
+        Rack::Lint.new(Rack::ServerStatus.new(app))
+      end
+      it do
+        response = Rack::MockRequest.new(subject).get('/')
+        expect(response.body).to eq 'Hello, World!'
+      end
+    end
+    context 'Affected WorkerScoreboard' do
+      subject do
+        Rack::Lint.new(Rack::ServerStatus.new(app, scoreboard_path: Dir.tmpdir))
+      end
+      it do
+        response = Rack::MockRequest.new(subject).get('/')
+        expect(response.body).to eq 'Hello, World!'
+      end
+    end
+  end
+
+  context 'return valid server-status' do
+    subject do
+      Rack::Lint.new(Rack::ServerStatus.new(app, scoreboard_path: Dir.tmpdir))
+    end
+    it do
+      response = Rack::MockRequest.new(subject).get('/server-status')
+      expect(response.successful?).to be_truthy
+      expect(response.headers['Content-Type']).to eq 'text/plain'
+    end
+  end
+
+  context 'return json valid server-status' do
+    subject do
+      Rack::Lint.new(Rack::ServerStatus.new(app, scoreboard_path: Dir.tmpdir))
+    end
+    it do
+      response = Rack::MockRequest.new(subject).get('/server-status?json')
+      expect(response.successful?).to be_truthy
+      expect(response.headers['Content-Type']).to eq 'application/json; charset=utf-8'
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib/rack/')
+require 'rack/server_status'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rack-server_status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SpringMT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: worker_scoreboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  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: Show server status
+email:
+- today.is.sky.blue.sky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".consolerc"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/server_status.rb
+- lib/rack/server_status/version.rb
+- rack-server_status.gemspec
+- spec/server_status_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SpringMT/rack-server_status
+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: '2.0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Show server status
+test_files:
+- spec/server_status_spec.rb
+- spec/spec_helper.rb
+has_rdoc: