puma-stats-logger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 951d3d4c27b7e5c9cb3b6a2ef6d63e223d75ebe0
-  data.tar.gz: 8e7e9acbd2b7d7ae4c39313a1bc9092d15a16e8f
+  metadata.gz: 791f449b3f7c87b41b434c8caa87be42192f741e
+  data.tar.gz: a13f557ed65e1947233ebd90722e8ce471492bae
 SHA512:
-  metadata.gz: b672425a657f0019241bda6f90cf8e5ca2d5e94b6ee71091f76c7eb1fa3dd0775a2e5a1038d1ca0e334ae966c4b25eb6830819fd43f4059735464014ca9c4c9c
-  data.tar.gz: 9f27c582b874caf89e6ef93789e28eeca74a3f00ed83c9d0df79514bd71a5e8be9c1c29be55172522b8ed66ab3d77477dddf0c787060ce1b5fb2f1e83d970b6e
+  metadata.gz: 4276834c44a84082a2123b65b085c24c021de20ff162e005bb3bc5b3cd2f40793c4a9dfcf48c98b17ed3632b4fe9f45b81e5f6f12b60502b9f5adf59c444f5b4
+  data.tar.gz: eea74cfd3692741243d6046d763c1575b5ec5cf351add44937f5f97e1374ce2f152dc552607639ef3c53a519b75683a18d37397a445591f29ac9db3c803e93ac

data/README.md

@@ -1,4 +1,67 @@
-puma-stats-logger
-=================
+## Puma Stats Logger
+
+#### For Rack apps (including Rails)
+
+This Rack middleware gathers statistics from [Puma](http://puma.io/) web server and logs them to the logging destination of your choice. It uses Puma's built in control server to query Puma's stats after every request in your production application. Currently, Puma provides two metrics that are output to your logs:
+
+  * __running__ - the number of threads currently running
+  * __backlog__ - the number of requests waiting to be processed by a thread
+
+The actual log entry looks like this:
+
+    measure#puma.backlog=0 measure#puma.running=6
+    
+    
+## Getting Started
+
+Add the gem to your gemfile:
+
+    gem 'puma-stats-logger'
+    
+##### Enable Puma's control/stats server & state file
+
+If you use a Puma configuration file, add the following two lines:
+
+    # in config/puma.rb
+    
+    activate_control_app
+    state_path 'tmp/puma.state'
+    
+OR ... if you don't use a Puma config file and you start Puma via command line, add these options:
+
+    puma --control auto --state "tmp/puma.state"
+    
+##### Activate the Middleware in your app
+
+In your application and/or environment config:
+
+    config.middleware.use PumaStatsLogger::Middleware
+   
+or in a Rails initializer:
+
+    Rails.application.middleware.use PumaStatsLogger::Middleware
+   
+   
+##### Changing the logging destination
+
+By default, the Puma stats are logged to standard output `$stdout`. This works great out of the box for Heroku users. You can customize this by passing an option hash:
+    
+    config.middleware.use PumaStatsLogger::Middleware, logger: Logger.new('destination/puma-stats.log')
+    
+
+## Visualizing Results
+
+We use the Librato add-on on Heroku to make nice charts of this data. You may have noticed that the log output is already formatted for Librato, so if you're already using Librato, Puma metrics should show up automatically under Metrics.
+
+![Puma stats in Librato](https://dmrxx81gnj0ct.cloudfront.net/public/Screen+Shot+2014-05-29+at+5.19.18+PM.png "Puma stats in Librato")
+
+## Open Source by Hired
+
+[Hired](https://hired.com/?utm_source=opensource&utm_medium=puma-stats-logger&utm_campaign=readme) is a marketplace for top engineering talent to find full-time technology jobs. Talented Ruby developers (like yourself) are in extremely high demand! On Hired, apply once and receive 5 to 15 competing job offers in one week from 800+ technology companies. Average Ruby engineer salaries on Hired are around $120,000 per year!
+
+<a href="https://hired.com/?utm_source=opensource&utm_medium=puma-stats-logger&utm_campaign=readme-banner" target="_blank">
+<img src="https://dmrxx81gnj0ct.cloudfront.net/public/hired-banner-light-1-728x90.png" alt="Hired" width="728" height="90" align="center"/>
+</a>
+
+We are Ruby developers ourselves, and we use all of our open source projects in production. We always encourge forks, pull requests, and issues. Get in touch with the Hired Engineering team at _opensource@hired.com_.
 
-A Rack middleware that collects stats from Puma webserver and outputs them for logging 

data/lib/puma_stats_logger/middleware.rb

@@ -31,7 +31,12 @@ module PumaStatsLogger
       end
 
       stats = JSON.parse(stats.split("\r\n").last)
-      @logger.info stats.map{|k,v| "measure#puma.#{k}=#{v}"}.join(' ')
+      line = String.new.tap do |s|
+        s << "source=#{ENV['DYNO']}" if ENV['DYNO']
+        s << stats.map{|k,v| "measure#puma.#{k}=#{v}"}.join(' ')
+      end
+
+      @logger.info line
     end
   end
 end

data/lib/puma_stats_logger/version.rb

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

data/spec/middleware_spec.rb

@@ -18,7 +18,7 @@ describe PumaStatsLogger::Middleware 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(
+      expect(Socket).to 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
@@ -31,6 +31,12 @@ describe PumaStatsLogger::Middleware do
       get "/"
       expect(log_output.string).to include('measure#puma.backlog=0 measure#puma.running=1')
     end
+
+    it "includes Heroku dyno information" do
+      ENV['DYNO'] = 'web.1'
+      get "/"
+      expect(log_output.string).to include('source=web.1')
+    end
   end
 
   context 'when a Puma state file does not exist' do

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma-stats-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hired, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake