sensible_logging 0.1.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573a3b8040fec85373dc5f2a00a82655e51ebe08d28b31c1a4dbfa3f18b0147f
-  data.tar.gz: 4d7d894842e36853317062862cd99577d9f61b78ad73fbbe909315ff14f8ecd6
+  metadata.gz: 9e38e81bacc78dc2cab4f5883bda17d8046982278eeff8f26b24e083439de8e7
+  data.tar.gz: 1043a629d3441cd7058b5be4545bae2abb06ec094d68fcfaa9e9604068f1e044
 SHA512:
-  metadata.gz: a8dea52bb2451b3bdcdce68b1ff75f5cfaa385b2321d9027b687f5b8bd27c5cef56d68fa197081a79cc0b4c11303e706867ad3ba6dd3ddba07c2f89b0a3f5004
-  data.tar.gz: 6b1ebcc33d6b13a5e4ce19307d538f4387ccfbd0e5cf5dcbc45d4729786e7ea2f41f917e80bed39d8c4b7aadf521aacb60e49061a23737581d23cfe907baac44
+  metadata.gz: 53f1b8eec5fcbb81457253943e1367bd3393e81955971e1a17ceee61df5594b2072407a51ca903c7e70605eff30d5855f55634251a2874a8217db0b2a46248ee
+  data.tar.gz: 15446e3ae903c6a5506e2af6a6f438da7ead8087456d89cf504ddfa4c4471f0218b6d9f57a099f443c78fc80192c0f56b81ea1b669d46b5c768cfc4c67e481b1

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [davidwinter]

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec --backtrace
+    - name: Run linting
+      run: bundle exec rubocop

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 pkg
+coverage

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+require: rubocop-rspec
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.6.1

data/.simplecov

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  minimum_coverage 100
+  if ENV['CI']
+    require 'codecov'
+    SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  end
+end

data/README.md

@@ -1,41 +1,148 @@
-# Sensible logging
+# Sensible Logging
 
-Proof of concept for some sensible defaults for logging in a Sinatra app.
+[![test](https://github.com/davidwinter/sensible_logging/workflows/test/badge.svg)](https://github.com/davidwinter/sensible_logging/actions?query=workflow%3Atest) [![Gem](https://img.shields.io/gem/dtv/sensible_logging)](https://rubygems.org/gems/sensible_logging)
 
-Plan will be to wrap this up in a single self contained gem that can easily be dropped into existing Sinatra applications.
+> A logging extension with sensible defaults for Sinatra apps.
 
 ## Features
 
-* Add (or use an existing) request ID for use in logs
-* Trim the request logs to the bare minimal (method, path, status, duration and params if a GET request) - similar to lograge with Rails
-* Tagged logging out of the box, with some sensible defaults; host, environment and request ID
+* Add a request UUID (or use an existing one if present in the `X-Request-Id` HTTP header) for use in logs, your app or other middlewares
+* Trim the request logs to the bare minimal (inspired by lograge):
+  * method
+  * path
+  * requesting IP address
+  * status
+  * duration
+  * params if a `GET` request
 
-## Demo
+  Example log line:
+  ```
+  method=GET path=/contact client=192.168.1.254 status=200 duration=0.124 params={"category"=>"question"}
+  ```
+* Tagged logging, with some sensible defaults:
+  * severity
+  * subdomain
+  * environment
+  * request UUID
 
-There is an example Sinatra app included in this repo, so:
+  Example log line:
+  ```
+  [INFO] [www.gb] [staging] [6004bb70-7b6d-43b6-a2cf-72d0336663ba] @todo tidy sql query
+  ```
 
-```
+## Usage
+
+1. Add `sensible_logging` to your `Gemfile` and install with `bundle install`:
+
+  ```ruby
+  gem 'sensible_logging'
+  ```
+2. In your `app.rb` register the module and then define your logging configuration:
+
+  ```ruby
+  require 'sensible_logging'
+
+  class App < Sinatra::Base
+    register Sinatra::SensibleLogging
+
+    # Initialise Sensible Logging to add our middlewares.
+    sensible_logging(
+      logger: Logger.new($stdout)
+      )
+
+    # Configure the log level for different environments
+    configure :production do
+      set :log_level, Logger::INFO
+    end
+
+    # Requests will be logged in a minimal format
+    get '/' do
+      'Hello!'
+    end
+
+    get '/about' do
+      # The standard Sinatra logger helper will use the Sensible Logging gem
+      logger.info('About page')
+    end
+
+    get '/contact' do
+      # In addition to the default tags, you can add additional ones by using the `tagged` block on the `logger` helper
+      # [INFO] [localhost] [development] [a9d0183d-a3c3-4081-b502-38dcf4c3c4d7] [todo] Contact page
+      logger.tagged('todo') do |logger|
+        logger.info('Contact page')
+      end
+    end
+
+  # rest of code omitted
+  ```
+
+### Available options
+
+There are a number of options that you can pass into `sensible_logging`:
+
+* `logger`: The logging object.
+  **Default**: `Logger.new($stdout)`
+* `use_default_log_tags`: Includes the subdomain, `RACK_ENV` and unique request ID in the log tags.
+  **Default**: `true`
+* `tld_length`: For example, if your domain was `www.google.com` this would result in `www` being tagged as your subdomain. If your domain is `www.google.co.uk`, set this value to `2` to correctly identify the subdomain as `www` rather than `www.google`.
+  **Default**: `1`.
+* `log_tags`: An array of additional log tags to include. This can be strings, or you can include a `lambda` that will be evaluated. The `lambda` is passed a Rack `Request` object, and it must return an array of string values.
+  **Default**: `[]`
+* `exclude_params`: An array of parameter names to be excluded from `GET` requests. By default, `GET` parameters are outputted in logs. If for example with the request `http://google.com/?one=dog&two=cat` you didn't want the `one` logged, you would set `exclude_params` to be `['one']`
+  **Default**: `[]`
+* `include_log_severity`: Includes the log severity in the tagged output, such as `INFO`, `DEBUG` etc
+  **Default**: `true`
+
+Sensible Logger will also respect the following Sinatra settings:
+
+* `log_level`: The level at which your logger object should respect logs. See above example.
+  **Default**: `Logger::DEBUG`
+
+## Examples
+
+There is an example Sinatra app included in this repo. Here's how to use it:
+
+```shell
 bundle install
+cd examples
 rackup
 ```
 
 With the app running, run some curl commands against it:
 
-```
+```shell
 curl 'localhost:9292/hello?one=two&two=three'
 ```
 
 You should notice in the logs:
 
 * Standard Sinatra `logger` helper works out of the box within apps with tags.
-* Excluded paramaters are not included, in this example `two` based on `config.ru`
+* Excluded parameters are not included, in this example `two` based on `config.ru`
 * The request log is minimal compared to out of the box Sinatra.
-* `env['request_id']` is now available to hook into Sentry reports.
+* `env['request_id']` is now available to group log lines from the same request together, or to use in additional services such as Sentry.
+
+## FAQ
+
+### Why is the timestamp absent?
+
+To quote [lograge][link_lograge] (which was the inspiration for this library):
+
+> The syntax is heavily inspired by the log output of the Heroku router. It doesn't include any timestamp by default, instead, it assumes you use a proper log formatter instead.
+
+## Releasing
+
+1. Update the version number `lib/sensible_logging/version.rb`
+2. Create a git commit and tag with the new version number
+3. Create a new PR with this change and once approved, merge to `main`
+4. Create a new PR with changes in `main` to be merged into `stable` since the last release
+5. Once approved and merged in, locally, run: `bundle exec rake release` which will build and push the new gem to Rubygems
+
+## Authors
 
-## Using
+By [David Winter](https://github.com/davidwinter) with contributions from [Mark Sta Ana](https://github.com/booyaa) & [Anthony King](https://github.com/cybojenix)
 
-Key thing is to wrap the Sinatra app in `sensible_logging` (as in `config.ru`) with your required options for logger, log tags and excluded parameters.
+## License
 
-## Todo
+MIT
 
-Need to ensure `sensible_logging` confirms to all of the relevant `productionisation` checklist items. Pretty much there though.
+[link_lograge]: https://github.com/roidrage/lograge#lograge---taming-rails-default-request-logging

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/examples/app.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+require 'logger'
+
+require_relative '../lib/sensible_logging'
+
+# Example Sinatra app
+class App < Sinatra::Base
+  register Sinatra::SensibleLogging
+
+  sensible_logging(
+    logger: Logger.new($stdout),
+    log_tags: [->(req) { [req.port] }],
+    exclude_params: ['two']
+  )
+
+  configure do
+    set :log_level, Logger::DEBUG
+  end
+
+  configure :production do
+    set :log_level, Logger::INFO
+  end
+
+  get '/hello' do
+    logger.tagged('todo') do |logger|
+      logger.debug('test')
+      env['rack.errors'].puts('This is an example error')
+    end
+    'test'
+  end
+
+  post '/' do
+    logger.debug('posting')
+    'posted'
+  end
+end

data/examples/config.ru

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative './app'
+
+run App

data/lib/sensible_logging.rb

@@ -1,18 +1,71 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+
 require_relative './sensible_logging/middlewares/request_id'
 require_relative './sensible_logging/middlewares/tagged_logger'
 require_relative './sensible_logging/middlewares/request_logger'
+require_relative './sensible_logging/helpers/logger_io_wrap'
+
+module Rack
+  # Disable Rack::CommonLogger
+  class CommonLogger
+    def call(env)
+      @app.call(env)
+    end
+  end
+end
+
+# Sinatra extension
+module Sinatra
+  # Sensible logging library for Sinatra based Apps
+  module SensibleLogging
+    def sensible_logging( # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      logger: Logger.new($stdout),
+      log_tags: [],
+      use_default_log_tags: true,
+      exclude_params: [],
+      tld_length: 1,
+      include_log_severity: true
+    )
+      setup_middlewares(
+        logger: logger,
+        log_tags: log_tags,
+        use_default_log_tags: use_default_log_tags,
+        exclude_params: exclude_params,
+        tld_length: tld_length,
+        include_log_severity: include_log_severity
+      )
+
+      before do
+        env['rack.logger'] = env['logger']
+        env['rack.errors'] = IOWrap.new(logger, level: Logger::ERROR)
+        logger.level = settings.log_level unless settings.log_level.nil?
+      end
+    end
 
-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
+    private
 
-  app.before do
-    env['rack.errors'] = env['rack.logger'] = env['logger']
-    if app.settings.log_level != nil
-      logger.level = app.settings.log_level
+    def setup_middlewares( # rubocop:disable Metrics/ParameterLists
+      logger:,
+      log_tags:,
+      use_default_log_tags:,
+      exclude_params:,
+      tld_length:,
+      include_log_severity:
+    )
+      use RequestId
+      use(
+        TaggedLogger,
+        logger: logger,
+        tags: log_tags,
+        use_default_tags: use_default_log_tags,
+        tld_length: tld_length,
+        include_log_severity: include_log_severity
+      )
+      use RequestLogger, exclude_params
     end
   end
 
-  app
+  register SensibleLogging
 end

data/lib/sensible_logging/helpers/logger_io_wrap.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# Wrap Logger objects to behave as IO objects in Rack
+class IOWrap
+  def initialize(logger, level: Logger::INFO)
+    @logger = logger
+    @level = level
+  end
+
+  def flush
+    # No-Op
+  end
+
+  def puts(message)
+    logger.add(level, message)
+  end
+
+  private
+
+  attr_reader :logger, :level
+end

data/lib/sensible_logging/helpers/subdomain_parser.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Returns subdomains from a full qualified domain name
+class SubdomainParser
+  attr_reader :tld_length
+
+  def initialize(tld_length: 1)
+    @tld_length = tld_length
+  end
+
+  def parse(host)
+    domain_parts = host.split('.')
+
+    return domain_parts[0] if domain_parts.size == 1
+
+    main_domain_length = tld_length + 1
+    subdomain_length = domain_parts.size - main_domain_length
+
+    subdomain_parts = domain_parts[0...subdomain_length]
+
+    return nil if subdomain_parts.empty?
+
+    subdomain_parts.join('.')
+  end
+end

data/lib/sensible_logging/middlewares/request_id.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
+# Captures request id
 class RequestId
   def initialize(app)
     @app = app

data/lib/sensible_logging/middlewares/request_logger.rb

@@ -1,20 +1,25 @@
+# frozen_string_literal: true
+
 require 'rack/request'
 
+# Captures information around  request
 class RequestLogger
   def initialize(app, filtered_params = [])
     @app = app
     @filtered_params = filtered_params
   end
 
-  def call(env)
+  def call(env) # rubocop:disable Metrics/AbcSize
     req = Rack::Request.new(env)
     start_time = Time.now
     status, headers, body = @app.call(env)
     end_time = Time.now - start_time
 
-    message = "method=#{req.request_method} path=#{req.path} status=#{status} duration=#{end_time}"
+    client_ip = req.ip || 'n/a'
+
+    message = "method=#{req.request_method} path=#{req.path} client=#{client_ip} status=#{status} duration=#{end_time}"
     filtered_params = filter_params(req)
-    message += " params=#{filtered_params}" if req.get? && ! filtered_params.empty?
+    message += " params=#{filtered_params}" if req.get? && !filtered_params.empty?
     env['logger'].info(message)
     [status, headers, body]
   end
@@ -22,6 +27,6 @@ class RequestLogger
   private
 
   def filter_params(req)
-    req.params.select { |x| ! @filtered_params.include?(x) }
+    req.params.reject { |x| @filtered_params.include?(x) }
   end
 end

data/lib/sensible_logging/middlewares/tagged_logger.rb

@@ -1,14 +1,31 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
 require 'active_support/tagged_logging'
+require_relative '../helpers/subdomain_parser'
 
+# Allow custom tags to be captured
 class TaggedLogger
-  def initialize(app, logger = Logger.new(STDOUT), tags = [], tld_length = 1)
+  def initialize( # rubocop:disable Metrics/MethodLength
+    app,
+    options = {}
+  )
     @app = app
-    @logger = ActiveSupport::TaggedLogging.new(logger)
 
-    @tags = tags
-    @tags = default_tags if tags.empty?
+    options = {
+      logger: Logger.new($stdout),
+      tags: [],
+      use_default_tags: true,
+      tld_length: 1,
+      include_log_severity: true
+    }.merge(options)
+
+    options[:logger] = setup_severity_tag(options[:logger]) if options[:include_log_severity]
 
-    @tld_length = tld_length
+    @logger = ActiveSupport::TaggedLogging.new(options[:logger])
+    @tags = []
+    @tags += default_tags(tld_length: options[:tld_length]) if options[:use_default_tags]
+    @tags += options[:tags]
   end
 
   def call(env)
@@ -18,26 +35,32 @@ class TaggedLogger
     end
   end
 
-  def default_tags
-    [lambda { |req|
-      [subdomain(req), ENV['RACK_ENV'], req.env['request_id']]
-    }]
-  end
-
   private
 
-  def subdomain(req)
-    domain_parts = req.host.split('.')
+  def setup_severity_tag(logger)
+    original_formatter = logger.formatter || ActiveSupport::Logger::SimpleFormatter.new
+    logger.formatter = proc do |severity, *args|
+      "[#{severity}] #{original_formatter.call(severity, *args)}"
+    end
+    logger
+  end
 
-    main_domain_length = @tld_length + 1
-    subdomain_length = domain_parts.length - main_domain_length
+  def default_tags(tld_length: 1)
+    [lambda { |req|
+      [subdomain(req.host, tld_length) || 'n/a', ENV['RACK_ENV'], req.env['request_id']]
+    }]
+  end
 
-    domain_parts[0...subdomain_length].join('.')
+  def subdomain(host, tld_length)
+    IPAddr.new(host)
+  rescue IPAddr::InvalidAddressError
+    subdomain_parser = SubdomainParser.new(tld_length: tld_length)
+    subdomain_parser.parse(host)
   end
 
   def generate_tags(env)
     req = Rack::Request.new(env)
-    tags = @tags.map do |tag|
+    @tags.map do |tag|
       tag.call(req)
     end
   end

data/lib/sensible_logging/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SensibleLogging
-  VERSION = "0.1.0"
+  VERSION = '0.4.2'
 end

data/sensible_logging.gemspec

@@ -1,31 +1,38 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 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.email         = ['sre@madetech.com']
+  spec.authors       = ['David Winter', 'Mark Sta Ana', 'Anthony King']
+  spec.email         = ['i@djw.me']
 
   spec.summary       = 'Sensible logging defaults for your Sinatra app'
-  spec.homepage      = 'https://github.com/madetech/sensible_logging'
+  spec.homepage      = 'https://github.com/davidwinter/sensible_logging'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
+  spec.required_ruby_version = '>= 2.6'
+
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rack', '~> 2.0'
   spec.add_runtime_dependency 'activesupport', '~> 5.2'
+  spec.add_runtime_dependency 'rack', '~> 2.0'
 
-  spec.add_development_dependency 'sinatra', '~> 2.0'
-  spec.add_development_dependency 'puma', '~> 3.12'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.2.0'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.add_development_dependency 'puma', '~> 5.3'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry', '~> 0.12.2'
+  spec.add_development_dependency 'rubocop', '~> 1.16.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.4.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sinatra', '~> 2.0'
 end

metadata

@@ -1,100 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: sensible_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.2
 platform: ruby
 authors:
 - David Winter
 - Mark Sta Ana
-autorequire: 
+- Anthony King
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,46 +125,95 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 1.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
-description: 
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
 email:
-- sre@madetech.com
+- i@djw.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
+- ".simplecov"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- app.rb
-- config.ru
+- examples/app.rb
+- examples/config.ru
 - lib/sensible_logging.rb
+- lib/sensible_logging/helpers/logger_io_wrap.rb
+- lib/sensible_logging/helpers/subdomain_parser.rb
 - lib/sensible_logging/middlewares/request_id.rb
 - lib/sensible_logging/middlewares/request_logger.rb
 - lib/sensible_logging/middlewares/tagged_logger.rb
 - lib/sensible_logging/version.rb
 - sensible_logging.gemspec
-homepage: https://github.com/madetech/sensible_logging
+homepage: https://github.com/davidwinter/sensible_logging
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,16 +221,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Sensible logging defaults for your Sinatra app
 test_files: []

data/app.rb

@@ -1,22 +0,0 @@
-require 'sinatra/base'
-require 'logger'
-
-class App < Sinatra::Base
-  configure do
-    set :log_level, Logger::DEBUG
-  end
-
-  configure :production do
-    set :log_level, Logger::INFO
-  end
-
-  get '/hello' do
-    logger.debug('test')
-    'test'
-  end
-
-  post '/' do
-    logger.debug('posting')
-    'posted'
-  end
-end

data/config.ru

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