rack-traffic-logger 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 046f870b9d6d0d7ad599d9be02eeab36373e32b6
-  data.tar.gz: ed3d557fd8e5c8f3b7a4293afdfc63d8380dc73b
+  metadata.gz: 14b29cb8230446091b0ff4d48a732e4cb907381c
+  data.tar.gz: 28bf54115618158d68942804a366894a3cc59537
 SHA512:
-  metadata.gz: 4d930ba34abf2ca3d9c6d8abe774b1c9efede75417cf0053de75c144281eed2c0525a9ce856892d70588bf9ed2b3487cd3f7569465c1cc1019c14c2ba426475d
-  data.tar.gz: a725b479cc1d70dad8d343a01a5c8eb9055ecc9b7ace87cff123f450043ae1dd7f4aeecfa64dd6794a2a99e7b5ea4462218b756c7a31b6897a49d0c9a8153fee
+  metadata.gz: f3deff06a541bab57142e46c2f11a077c4dc9ea662e11585f7f4df00836a8d50a45a65f4d9317c93afca930382ef694be3fa56404553f70079d39b455763ede1
+  data.tar.gz: 71d3bebc92b6b9e4587a25826f18813feb76a901e1c990b3b578dd06945137d5c2e71a632f994882a09fe6b32a8e25a89a56820f531461f881d8050b09de6116

data/README.md

@@ -153,6 +153,39 @@ It's ruby, plus these rules:
 - Use `a` for `all`, `h` for `headers`, `b` for `bodies`, `ih` for `request_headers`, `ib` for `request_bodies`, `oh` for `response_headers`, and `ob` for `response_bodies` (think of `i` for *input*, and `o` for *output*).
 - Use `o` for `only` and `f` for false.
 
+### Express Setup
+
+If you're reading log config from an environment variable, use express setup in place of `use` in a rack-up file to conditionally set up logging on your stack.
+
+```ruby
+# config.ru
+Rack::TrafficLogger.use on: self
+```
+
+Or, with some configuration:
+
+```ruby
+# config.ru
+Rack::TrafficLogger.use on: self,
+                        filter: ENV['LOG_INBOUND_HTTP'],
+                        formatter: Rack::TrafficLogger::Formatter::JSON.new,
+                        log_path: ::File.expand_path('../log/http_in.log', __FILE__)
+
+```
+
+- Express setup will send `use` to the object passed to the `on:` argument. In a rack-up file, pass `self`.
+- Logging will not be set up if `filter` is one of: `0 no false none off nil`, or a blank string.
+- Logging will revert to basic logging (no headers or bodies) if `filter` is one of `1 yes true normal basic minimal on`.
+- Omit `filter` to use default (basic) log filtering.
+- Omit `formatter` to use default (stream-like) log formatting.
+- Omit `log_path` to write directly to standard output (via `/dev/stdout`).
+
+Under typical conditions, express setup internally calls:
+
+```ruby
+on.use Rack::TrafficLogger, log_path, formatter, format
+```
+
 ### Tailing a JSON log
 
 Tailing a JSON log can induce migraines. There are a couple of solutions:

data/lib/rack/traffic_logger/express_setup.rb

@@ -0,0 +1,19 @@
+module Rack
+  class TrafficLogger
+
+    def self.use(on: nil, filter: '', log_path: '/dev/stdout', formatter: nil)
+      filter = (filter || '').to_s.downcase.strip
+      unless ['0', 'no', 'false', 'nil', 'none', '', 'off'].include? filter
+        args = [Rack::TrafficLogger, log_path]
+        args << formatter if formatter
+        begin
+          raise if %w[1 yes true normal basic minimal on].include? filter
+          on.use *args, filter
+        rescue
+          on.use *args
+        end
+      end
+    end
+
+  end
+end

data/lib/rack/traffic_logger/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class TrafficLogger
-    VERSION = '0.2.3'
+    VERSION = '0.2.4'
   end
 end

data/lib/rack/traffic_logger.rb

@@ -4,6 +4,7 @@ require_relative 'traffic_logger/option_interpreter'
 require_relative 'traffic_logger/stream_simulator'
 require_relative 'traffic_logger/formatter'
 require_relative 'traffic_logger/reader'
+require_relative 'traffic_logger/express_setup'
 
 require 'json'
 require 'securerandom'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-traffic-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Neil E. Pearson
@@ -37,6 +37,7 @@ files:
 - bin/parse-rack-traffic-log
 - lib/rack/traffic_logger.rb
 - lib/rack/traffic_logger/echo.rb
+- lib/rack/traffic_logger/express_setup.rb
 - lib/rack/traffic_logger/formatter.rb
 - lib/rack/traffic_logger/formatter/json.rb
 - lib/rack/traffic_logger/formatter/stream.rb