frankenstein 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43e6658a05dd6f1406af38841a88b1c4a8f0e0c8
-  data.tar.gz: 66a2d42cee1f6e7a5d9685cd54aa24520e9efcba
+  metadata.gz: b078bfb45f77f51b4bd6e5b28aa3f2e7e5607a21
+  data.tar.gz: 78da8f3428955ece59e4d10bbb04a05fbdc23609
 SHA512:
-  metadata.gz: 0f24f97eabdfb426390ef6a5474ec8cf74db408523c3802a56ab2691cfb92a4968e40fdb724138f6166b3464b9cf885c6bd1d4c6cd2f882f66cc54b4f0763603
-  data.tar.gz: d7b6a0fd0811305b2960ad5c4557dd1a8fcf9236ac29588da6684af2c4acdfdd7cc5cfd607978842ee8ae0aa52d4200b67b9c1fbb55d7e905838091929ed11b9
+  metadata.gz: 802b00805c5c4366f720835590eeec6afbc4735118c88c2224ae477ac80a8a3d075b4353318e351b8041cf921969ae66d539542872186167196d89612297bbf2
+  data.tar.gz: beae09c8b7d81e80c8f856b93ed217d54a565e4b2b9925949a2539235720c11beb9b7043152d25c313704936691c6601c64ee8fbe84960899a2ba88a1992831f

data/lib/frankenstein/server/webrick_logger.rb

@@ -0,0 +1,56 @@
+require 'logger'
+
+module Frankenstein
+  class Server
+    # Wrap a logger in behaviour that suits WEBrick's ideosyncratic style
+    #
+    # There are a few things in the way that WEBrick interacts with the standard
+    # Logger class which don't suit modern logging practices:
+    #
+    # * It doesn't set a `progname` when logging, which makes it much harder to
+    #   separate out WEBrick logs from other parts of your system.
+    # * Logging calls use the direct-pass approach to passing in strings, which
+    #   degrades performance.
+    # * Access logging doesn't log with a priority, making it impossible to
+    #   selectively log or not log access logs.
+    # * Access logging doesn't respect the logger formatting, making it much harder
+    #   to parse logs than it should need to be.
+    #
+    # This class is an attempt to capture all that aberrant behaviour and redirect
+    # it into more socially-acceptable forms:
+    #
+    # * All of the "priority" methods (`warn`, `debug`, etc) are wrapped to inject
+    #   `progname`.
+    # * Access logging (or, more precisely, all calls to `#<<`) are intercepted
+    #   and logged via the standard (format-respecting) calls, with the specified priority.
+    #
+    # This will *hopefully* provide a more palatable WEBrick logging experience.
+    #
+    class WEBrickLogger
+      # @param logger [Logger] the *actual* Logger you want to send all of the log
+      #    messages to.
+      # @param progname [#to_s] the `progname` you want to pass to all log messages
+      #    that come through this wrapper.
+      # @param access_log_priority [Fixnum] the priority at which to log access log messages.
+      #    Any of the `Logger::*` priority constants will work Just Fine.
+      #
+      def initialize(logger:, progname: "WEBrick", access_log_priority: Logger::DEBUG)
+        @logger, @progname, @priority = logger, progname, access_log_priority
+      end
+
+      %i{debug error fatal info warn}.each do |sev|
+        define_method(sev) do |msg, &blk|
+          if blk
+            @logger.__send__(sev, @progname, &blk)
+          else
+            @logger.__send__(sev, @progname) { msg }
+          end
+        end
+      end
+
+      def <<(msg)
+        @logger.add(@priority, msg, @progname)
+      end
+    end
+  end
+end

data/lib/frankenstein/server.rb

@@ -8,6 +8,7 @@ require 'rack/handler/webrick'
 require 'rack/deflater'
 
 require 'frankenstein/error'
+require 'frankenstein/server/webrick_logger'
 
 module Frankenstein
   # A straightforward Prometheus metrics server.
@@ -23,7 +24,7 @@ module Frankenstein
   #     stats_server.run   # We are now serving stats on port 8080!
   #     counter = stats_server.registry.counter(:seconds_count, "Number of seconds")
   #     # Give the counter something to count
-  #     loop { counter.increment({}) }
+  #     loop { sleep 1; counter.increment({}) }
   #
   # Now if you hit http://localhost:8080/metrics you should see a counter
   # gradually going up, along with stats about the Frankenstein HTTP server
@@ -65,7 +66,7 @@ module Frankenstein
       @op_cv    = ConditionVariable.new
     end
 
-    # Start the server instance running.
+    # Start the server instance running in a separate thread.
     #
     # This method returns once the server is just about ready to start serving
     # requests.
@@ -76,11 +77,22 @@ module Frankenstein
 
         @server_thread = Thread.new do
           @op_mutex.synchronize do
-            @server = WEBrick::HTTPServer.new(Logger: @logger, BindAddress: nil, Port: @port)
-            @server.mount "/", Rack::Handler::WEBrick, app
-            @op_cv.signal
+            begin
+              wrapped_logger = Frankenstein::Server::WEBrickLogger.new(logger: @logger)
+              @server = WEBrick::HTTPServer.new(Logger: wrapped_logger, BindAddress: nil, Port: @port, AccessLog: [[wrapped_logger, WEBrick::AccessLog::COMMON_LOG_FORMAT]])
+              @server.mount "/", Rack::Handler::WEBrick, app
+            rescue => ex
+              @logger.fatal("Frankenstein::Server#run") { (["Exception while trying to create WEBrick::HTTPServer: #{ex.message} (#{ex.class})"] + ex.backtrace).join("\n  ") }
+            ensure
+              @op_cv.signal
+            end
+          end
+
+          begin
+            @server.start if @server
+          rescue => ex
+            @logger.fatal("Frankenstein::Server#run") { (["Exception while running WEBrick::HTTPServer: #{ex.message} (#{ex.class})"] + ex.backtrace).join("\n  ") }
           end
-          @server.start
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frankenstein
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -229,6 +229,7 @@ files:
 - lib/frankenstein/error.rb
 - lib/frankenstein/request.rb
 - lib/frankenstein/server.rb
+- lib/frankenstein/server/webrick_logger.rb
 homepage: https://github.com/discourse/frankenstein
 licenses: []
 metadata: {}
@@ -248,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: or, the Modern Prometheus