rack-traffic-logger 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f50ccbadf767b049731815d271ce316d986d916a
-  data.tar.gz: a6a970b4368ff2ed2a88a3ab66384dc32e046220
+  metadata.gz: b956c1f090a00f5a1a2a9312a2d75d553110a1a5
+  data.tar.gz: 61e0c4abd72b7273951b6b6a3bcca482b0debea1
 SHA512:
-  metadata.gz: 29df161ebf86d8f6735f92f8d85314450c53534ef9e6fbcc0c67edc0f306b014bea4cd5920a41e520e9f86698feb85d5b1bf5d948764cb8bd64e4c73d00b3a11
-  data.tar.gz: 8331c0187a9d47ecbda6972f18724801dc6b3b806f32f5c1a95af3f220320eb71d79db85c9fbfb7047652ee2f1d0345d73ebc3762816e609d483d17bc822de24
+  metadata.gz: 1a1f32d6b739d39af2375383f659aa3f9efa37a69d47e0c8f6ddb22b2bca5dc355074f2e879590109fd2f035c2aaa7d0e84f35734535e4346514bbfb1dff7d89
+  data.tar.gz: 81552abbaa6f568e6af21cb2e88fb0c98c831b602b54cae47883981d4d6eb2b568977e975ea31dd2af132af1c73a4e84eb9dcd8a1e5bf537e91afd3b4c63110d

data/README.md

@@ -133,3 +133,33 @@ If you need to, you can get pretty fancy:
 use Rack::TrafficLogger, 'file.log', :request_headers, 401 => false, 500...600 => :all, 200...300 => {post: :request_bodies, delete: false}
 use Rack::TrafficLogger, 'file.log', [:get, :head] => 200..204, post: {only: {201 => :request_bodies}}, [:put, :patch] => :all
 ```
+
+### Tailing a JSON log
+
+Tailing a JSON log can induce migraines. There are a couple of solutions:
+
+#### Pipe it through the log parser
+
+This gem is bundled with the `parse-rack-traffic-log` executable for this exact purpose.
+
+```bash
+tail -f traffic.log | parse-rack-traffic-log
+```
+
+This will let you tail a JSON log as if it were a regular log. You can add colors and/or JSON pretty printing using environment variables:
+
+```bash
+tail -f traffic.log | PRETTY_PRINT=1 COLOR=1 parse-rack-traffic-log
+```
+
+I haven't tested this with `less` but it should give the same result.
+
+#### Use pretty-printing
+
+You can make the JSON formatter output pretty:
+
+```ruby
+use Rack::TrafficLogger, 'file.log', Rack::TrafficLogger::Formatter::JSON.new(pretty_print: true)
+```
+
+Note that if you do, log parsers may have a hard time understanding your logs if they expect each event to be on a single line. If you think this could be an issue, use the first method instead.

data/lib/rack/traffic_logger/reader.rb

@@ -0,0 +1,49 @@
+require 'json'
+require 'time'
+
+module Rack
+  class TrafficLogger
+    class Reader
+
+      def self.start(input, output, **options)
+        new input, output, **options
+      end
+
+      def initialize(input, output, **options)
+        @input = input
+        @output = output
+        @formatter = Formatter::Stream.new(**options)
+        Signal.trap('INT') { exit 0 }
+        loop { readline }
+      end
+
+      # Reads a line from input, formats it, and sends it to output
+      def readline
+        buffer = ''
+        loop do
+          begin
+            buffer << @input.read_nonblock(1)
+            return writeline buffer if buffer[-1] == "\n"
+          rescue IO::EAGAINWaitReadable
+            sleep 0.1
+          rescue EOFError
+            exit 0
+          end
+        end
+      end
+
+      def writeline(line)
+        begin
+          hash = JSON.parse(line)
+          hash[:timestamp] = Time.parse(hash['timestamp'])
+          hash[:request_log_id] = hash['request_log_id']
+          hash[:event] = hash['event']
+          @output << @formatter.format(hash)
+        rescue
+          @output << line
+        end
+      end
+
+    end
+  end
+end

data/lib/rack/traffic_logger/stream_simulator.rb

@@ -48,7 +48,8 @@ module Rack
         result = render RESPONSE_TEMPLATES[@color],
                         http: input['http_version'] || 'HTTP/1.1',
                         code: input['status_code'],
-                        status: input['status_name']
+                        status: input['status_name'],
+                        color: status_color(input['status_code'])
         headers = input['headers']
         result << format_headers(headers) if headers
         result << format_body(input, headers && headers['Content-Type'])
@@ -82,6 +83,14 @@ module Rack
         env.select { |k, _| k =~ /^(CONTENT|HTTP)_(?!VERSION)/ }.map { |(k, v)| [k.sub(/^HTTP_/, ''), v] }.to_h
       end
 
+      def status_color(status)
+        case (status.to_i / 100).to_i
+          when 2 then '32m'
+          when 4, 5 then '31m'
+          else '33m'
+        end
+      end
+
     end
   end
 end

data/lib/rack/traffic_logger/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class TrafficLogger
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

data/lib/rack/traffic_logger.rb

@@ -3,6 +3,7 @@ require_relative 'traffic_logger/header_hash'
 require_relative 'traffic_logger/option_interpreter'
 require_relative 'traffic_logger/stream_simulator'
 require_relative 'traffic_logger/formatter'
+require_relative 'traffic_logger/reader'
 
 require 'json'
 require 'securerandom'
@@ -44,7 +45,7 @@ module Rack
       if @log_path.respond_to? :write
         @log_path.write data
       else
-        File.write @log_path, data, mode: 'a', encoding: data.encoding
+        ::File.write @log_path, data, mode: 'a', encoding: data.encoding
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-traffic-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Neil E. Pearson
@@ -40,6 +40,7 @@ files:
 - lib/rack/traffic_logger/formatter/stream.rb
 - lib/rack/traffic_logger/header_hash.rb
 - lib/rack/traffic_logger/option_interpreter.rb
+- lib/rack/traffic_logger/reader.rb
 - lib/rack/traffic_logger/stream_simulator.rb
 - lib/rack/traffic_logger/version.rb
 homepage: https://github.com/hx/rack-traffic-logger