puma-stats-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 951d3d4c27b7e5c9cb3b6a2ef6d63e223d75ebe0
+  data.tar.gz: 8e7e9acbd2b7d7ae4c39313a1bc9092d15a16e8f
+SHA512:
+  metadata.gz: b672425a657f0019241bda6f90cf8e5ca2d5e94b6ee71091f76c7eb1fa3dd0775a2e5a1038d1ca0e334ae966c4b25eb6830819fd43f4059735464014ca9c4c9c
+  data.tar.gz: 9f27c582b874caf89e6ef93789e28eeca74a3f00ed83c9d0df79514bd71a5e8be9c1c29be55172522b8ed66ab3d77477dddf0c787060ce1b5fb2f1e83d970b6e

data/.gitignore

@@ -0,0 +1,2 @@
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    puma-stats-logger (0.1.0)
+      json
+      puma
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    puma (2.8.2)
+      rack (>= 1.1, < 2.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  puma-stats-logger!
+  rack-test
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Hired, Inc.
+
+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,4 @@
+puma-stats-logger
+=================
+
+A Rack middleware that collects stats from Puma webserver and outputs them for logging 

data/lib/puma-stats-logger.rb

@@ -0,0 +1,6 @@
+require 'socket'
+require 'yaml'
+require 'json'
+require 'logger'
+require 'puma/configuration'
+require 'puma_stats_logger/middleware'

data/lib/puma_stats_logger/middleware.rb

@@ -0,0 +1,37 @@
+module PumaStatsLogger
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+      @logger = options[:logger] || Logger.new($stdout)
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      log_puma_stats if puma_options
+      [status, headers, body]
+    end
+
+    private
+
+    def puma_options
+      @puma_options ||= begin
+        return nil unless File.exists?(puma_state_file)
+        YAML.load_file(puma_state_file)['config'].options
+      end
+    end
+
+    def puma_state_file
+      'tmp/puma.state'
+    end
+
+    def log_puma_stats
+      stats = Socket.unix(puma_options[:control_url].gsub('unix://', '')) do |socket|
+        socket.print("GET /stats?token=#{puma_options[:control_auth_token]} HTTP/1.0\r\n\r\n")
+        socket.read
+      end
+
+      stats = JSON.parse(stats.split("\r\n").last)
+      @logger.info stats.map{|k,v| "measure#puma.#{k}=#{v}"}.join(' ')
+    end
+  end
+end

data/lib/puma_stats_logger/version.rb

@@ -0,0 +1,3 @@
+module PumaStatsLogger
+  VERSION = '0.1.0'
+end

data/puma-stats-logger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puma_stats_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puma-stats-logger"
+  spec.version       = PumaStatsLogger::VERSION
+  spec.authors       = ["Hired, Inc", "Nate Clark"]
+  spec.email         = ["opensource@hired.com"]
+  spec.summary       = %q{A Rack middleware that collects stats from Puma webserver and outputs them for logging }
+  spec.description   = %q{A Rack middleware that collects stats from Puma webserver and outputs them for logging }
+  spec.homepage      = "https://github.com/hired/puma-stats-logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
+
+  spec.add_dependency "json"
+  spec.add_dependency "puma"
+
+end

data/spec/files/puma.state

@@ -0,0 +1,21 @@
+---
+pid: 57709
+config: !ruby/object:Puma::Configuration
+  options:
+    :min_threads: 0
+    :max_threads: 10
+    :quiet: false
+    :debug: false
+    :binds:
+    - tcp://0.0.0.0:3000
+    :workers: 0
+    :daemon: false
+    :worker_directory: "/Users/nate/workspace/hired"
+    :config_file: config/puma.rb
+    :mode: :http
+    :worker_timeout: 60
+    :environment: development
+    :control_url: unix:///var/folders/_h/30bzldts3gj3n2tknnzcqsl40000gn/T/puma-status-1401402163005-57709
+    :state: tmp/puma.state
+    :control_url_temp: "/var/folders/_h/30bzldts3gj3n2tknnzcqsl40000gn/T/puma-status-1401402163005-57709"
+    :control_auth_token: a56928e2d78ffb8879a937d35b78510

data/spec/middleware_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe PumaStatsLogger::Middleware do
+  include Rack::Test::Methods
+
+  class SampleApplication
+    def call(env)
+      [200, {}, ""]
+    end
+  end
+
+  let(:app) { PumaStatsLogger::Middleware.new(SampleApplication.new, logger: logger) }
+  let(:logger) { Logger.new(log_output)}
+  let(:log_output) { StringIO.new }
+
+  context 'when a Puma state file exists' do
+    before do
+      FileUtils.cp './spec/files/puma.state', 'tmp/puma.state'
+
+      # stub what the Puma stats server would return
+      Socket.should_receive(:unix).with('/var/folders/_h/30bzldts3gj3n2tknnzcqsl40000gn/T/puma-status-1401402163005-57709').and_return(
+        "HTTP/1.0 200 OK\r\nContent-Type: application/json\r\nConnection: close\r\nContent-Length: 30\r\n\r\n{ \"backlog\": 0, \"running\": 1 }"
+      )
+    end
+
+    after do
+      FileUtils.rm './tmp/puma.state'
+    end
+
+    it "outputs the puma stats" do
+      get "/"
+      expect(log_output.string).to include('measure#puma.backlog=0 measure#puma.running=1')
+    end
+  end
+
+  context 'when a Puma state file does not exist' do
+    it "does nothing" do
+      get "/"
+      expect(log_output.string).to be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec/autorun'
+require 'rack/test'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/puma-stats-logger'))

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: puma-stats-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hired, Inc
+- Nate Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: puma
+  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'
+description: 'A Rack middleware that collects stats from Puma webserver and outputs
+  them for logging '
+email:
+- opensource@hired.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/puma-stats-logger.rb
+- lib/puma_stats_logger/middleware.rb
+- lib/puma_stats_logger/version.rb
+- puma-stats-logger.gemspec
+- spec/files/puma.state
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- tmp/.gitkeep
+homepage: https://github.com/hired/puma-stats-logger
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Rack middleware that collects stats from Puma webserver and outputs them
+  for logging
+test_files:
+- spec/files/puma.state
+- spec/middleware_spec.rb
+- spec/spec_helper.rb