sensible_logging 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64e20e7d13d4881981be87fa54a55d5dd4341a4c2fb3d6288f2ad68a35c1f096
-  data.tar.gz: 07a666fe48011d6c8b76b173161613973fe34bbfaf0994c15a06481744236829
+  metadata.gz: 40ddd14f9217b3c9465bf528d8a1a2befb3ff17177340d119533e58d16e208de
+  data.tar.gz: 5a20a67b1f01cc7fdd4f7ec7959472086e2d73987ab5c2d6d54f1cbc823d4183
 SHA512:
-  metadata.gz: 9e7645eb34a56cfc7f8187c894a7195a9ec60a469c2efe3da221f3e176149a1164a175c433821222cfe8f2294b4c79abd036b759dfb1ceb8155fc6c10d25c4c7
-  data.tar.gz: 62b656360bed805e943fa1b0c8b6ca5614d0c7af8e4caa447ade4f067b8b6f62fef5905faf9dc33f1e5219d2a2bd994020d48dabb9b506b8351b458fbc7f0016
+  metadata.gz: 0f17b47325de077896ae98001452e19a02df1ba12fce8734139ec47d665a1dc8db77609c15d127ff74c8da57e1aebd0f2464c5fa63d530b1e6443d47e37a8c7a
+  data.tar.gz: cea09e17ded5de488a701a7aa5e737320ab9c6e444493669d996e57c4979a14199b979eac44cc2f8232a6c5cc6e58619205393a7f43b1436db1f9fa7aadae440

data/examples/app.rb

@@ -1,7 +1,17 @@
 require 'sinatra/base'
 require 'logger'
 
+require_relative '../lib/sensible_logging'
+
 class App < Sinatra::Base
+  register Sinatra::SensibleLogging
+
+  sensible_logging(
+    logger: Logger.new(STDOUT),
+    log_tags: [lambda { |req| [req.port] }],
+    exclude_params: ['two']
+  )
+
   configure do
     set :log_level, Logger::DEBUG
   end

data/examples/config.ru

@@ -1,11 +1,4 @@
 #\ --quiet
-require 'logger'
 require_relative './app'
-require_relative '../lib/sensible_logging'
 
-run sensible_logging(
-  app: App,
-  logger: Logger.new(STDOUT),
-  log_tags: TaggedLogger.default_tags + [lambda { |req| [req.port] }],
-  exclude_params: ['two']
-)
+run App

data/lib/sensible_logging/middlewares/tagged_logger.rb

@@ -2,12 +2,13 @@ require 'active_support/tagged_logging'
 require_relative '../helpers/subdomain_parser'
 
 class TaggedLogger
-  def initialize(app, logger = Logger.new(STDOUT), tags = [], tld_length = 1)
+  def initialize(app, logger = Logger.new(STDOUT), tags = [], use_default_log_tags = true, tld_length = 1)
     @app = app
     @logger = ActiveSupport::TaggedLogging.new(logger)
 
-    @tags = tags
-    @tags = self.class.default_tags(tld_length: tld_length) if tags.empty?
+    @tags = []
+    @tags += default_tags(tld_length: tld_length) if use_default_log_tags
+    @tags += tags
   end
 
   def call(env)
@@ -17,7 +18,9 @@ class TaggedLogger
     end
   end
 
-  def self.default_tags(tld_length: 1)
+  private
+
+  def default_tags(tld_length: 1)
     [lambda { |req|
       subdomain_parser = SubdomainParser.new(tld_length: tld_length)
       subdomain = subdomain_parser.parse(req.host)
@@ -26,8 +29,6 @@ class TaggedLogger
     }]
   end
 
-  private
-
   def generate_tags(env)
     req = Rack::Request.new(env)
     tags = @tags.map do |tag|

data/lib/sensible_logging/version.rb

@@ -1,3 +1,3 @@
 module SensibleLogging
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/sensible_logging.rb

@@ -1,18 +1,30 @@
+require 'sinatra/base'
+
 require_relative './sensible_logging/middlewares/request_id'
 require_relative './sensible_logging/middlewares/tagged_logger'
 require_relative './sensible_logging/middlewares/request_logger'
 
-def sensible_logging(app:, logger:, log_tags: [], exclude_params: [], tld_length: 1)
-  use RequestId
-  use TaggedLogger, logger, log_tags, tld_length
-  use RequestLogger, exclude_params
+module Sinatra
+  module SensibleLogging
+    def sensible_logging(
+      logger:,
+      log_tags: [],
+      use_default_log_tags: true,
+      exclude_params: [],
+      tld_length: 1
+    )
+      use RequestId
+      use TaggedLogger, logger, log_tags, use_default_log_tags, tld_length
+      use RequestLogger, exclude_params
 
-  app.before do
-    env['rack.errors'] = env['rack.logger'] = env['logger']
-    if app.settings.log_level != nil
-      logger.level = app.settings.log_level
+      before do
+        env['rack.errors'] = env['rack.logger'] = env['logger']
+        if settings.log_level != nil
+          logger.level = settings.log_level
+        end
+      end
     end
   end
 
-  app
+  register SensibleLogging
 end

data/sensible_logging.gemspec

@@ -6,7 +6,7 @@ require 'sensible_logging/version'
 Gem::Specification.new do |spec|
   spec.name          = 'sensible_logging'
   spec.version       = SensibleLogging::VERSION
-  spec.authors       = ['David Winter', 'Mark Sta Ana']
+  spec.authors       = ['David Winter', 'Mark Sta Ana', 'Anthony King']
   spec.email         = ['sre@madetech.com']
 
   spec.summary       = 'Sensible logging defaults for your Sinatra app'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sensible_logging
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Winter
 - Mark Sta Ana
+- Anthony King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack