sensible_logging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 573a3b8040fec85373dc5f2a00a82655e51ebe08d28b31c1a4dbfa3f18b0147f
+  data.tar.gz: 4d7d894842e36853317062862cd99577d9f61b78ad73fbbe909315ff14f8ecd6
+SHA512:
+  metadata.gz: a8dea52bb2451b3bdcdce68b1ff75f5cfaa385b2321d9027b687f5b8bd27c5cef56d68fa197081a79cc0b4c11303e706867ad3ba6dd3ddba07c2f89b0a3f5004
+  data.tar.gz: 6b1ebcc33d6b13a5e4ce19307d538f4387ccfbd0e5cf5dcbc45d4729786e7ea2f41f917e80bed39d8c4b7aadf521aacb60e49061a23737581d23cfe907baac44

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Winter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Sensible logging
+
+Proof of concept for some sensible defaults for logging in a Sinatra app.
+
+Plan will be to wrap this up in a single self contained gem that can easily be dropped into existing Sinatra applications.
+
+## 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
+
+## Demo
+
+There is an example Sinatra app included in this repo, so:
+
+```
+bundle install
+rackup
+```
+
+With the app running, run some curl commands against it:
+
+```
+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`
+* The request log is minimal compared to out of the box Sinatra.
+* `env['request_id']` is now available to hook into Sentry reports.
+
+## Using
+
+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.
+
+## Todo
+
+Need to ensure `sensible_logging` confirms to all of the relevant `productionisation` checklist items. Pretty much there though.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app.rb

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,11 @@
+#\ --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']
+)

data/lib/sensible_logging.rb

@@ -0,0 +1,18 @@
+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
+
+  app.before do
+    env['rack.errors'] = env['rack.logger'] = env['logger']
+    if app.settings.log_level != nil
+      logger.level = app.settings.log_level
+    end
+  end
+
+  app
+end

data/lib/sensible_logging/middlewares/request_id.rb

@@ -0,0 +1,20 @@
+require 'securerandom'
+
+class RequestId
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    env['request_id'] = env['HTTP_X_REQUEST_ID'] || new_request_id
+    status, headers, body = @app.call(env)
+    headers['X-Request-Id'] ||= env['request_id']
+    [status, headers, body]
+  end
+
+  private
+
+  def new_request_id
+    SecureRandom.uuid
+  end
+end

data/lib/sensible_logging/middlewares/request_logger.rb

@@ -0,0 +1,27 @@
+require 'rack/request'
+
+class RequestLogger
+  def initialize(app, filtered_params = [])
+    @app = app
+    @filtered_params = filtered_params
+  end
+
+  def call(env)
+    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}"
+    filtered_params = filter_params(req)
+    message += " params=#{filtered_params}" if req.get? && ! filtered_params.empty?
+    env['logger'].info(message)
+    [status, headers, body]
+  end
+
+  private
+
+  def filter_params(req)
+    req.params.select { |x| ! @filtered_params.include?(x) }
+  end
+end

data/lib/sensible_logging/middlewares/tagged_logger.rb

@@ -0,0 +1,44 @@
+require 'active_support/tagged_logging'
+
+class TaggedLogger
+  def initialize(app, logger = Logger.new(STDOUT), tags = [], tld_length = 1)
+    @app = app
+    @logger = ActiveSupport::TaggedLogging.new(logger)
+
+    @tags = tags
+    @tags = default_tags if tags.empty?
+
+    @tld_length = tld_length
+  end
+
+  def call(env)
+    @logger.tagged(*generate_tags(env)) do |logger|
+      env['logger'] = logger
+      @app.call(env)
+    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('.')
+
+    main_domain_length = @tld_length + 1
+    subdomain_length = domain_parts.length - main_domain_length
+
+    domain_parts[0...subdomain_length].join('.')
+  end
+
+  def generate_tags(env)
+    req = Rack::Request.new(env)
+    tags = @tags.map do |tag|
+      tag.call(req)
+    end
+  end
+end

data/lib/sensible_logging/version.rb

@@ -0,0 +1,3 @@
+module SensibleLogging
+  VERSION = "0.1.0"
+end

data/sensible_logging.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$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.summary       = 'Sensible logging defaults for your Sinatra app'
+  spec.homepage      = 'https://github.com/madetech/sensible_logging'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rack', '~> 2.0'
+  spec.add_runtime_dependency 'activesupport', '~> 5.2'
+
+  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 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.12.2'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: sensible_logging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Winter
+- Mark Sta Ana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: 
+email:
+- sre@madetech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app.rb
+- config.ru
+- lib/sensible_logging.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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Sensible logging defaults for your Sinatra app
+test_files: []