sensible_logging 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40ddd14f9217b3c9465bf528d8a1a2befb3ff17177340d119533e58d16e208de
-  data.tar.gz: 5a20a67b1f01cc7fdd4f7ec7959472086e2d73987ab5c2d6d54f1cbc823d4183
+  metadata.gz: b91e1451d99dabecf5e9126f248426ca32d622fd4aa90e73cd80b6a034f1ca98
+  data.tar.gz: c7d8e9bd3ef502279b40c133a2aff29c9cfde8ed24985362d848960221c38d31
 SHA512:
-  metadata.gz: 0f17b47325de077896ae98001452e19a02df1ba12fce8734139ec47d665a1dc8db77609c15d127ff74c8da57e1aebd0f2464c5fa63d530b1e6443d47e37a8c7a
-  data.tar.gz: cea09e17ded5de488a701a7aa5e737320ab9c6e444493669d996e57c4979a14199b979eac44cc2f8232a6c5cc6e58619205393a7f43b1436db1f9fa7aadae440
+  metadata.gz: 57c777173f5b0f66a26f6b5b3761d148de8e9f11af77bee6a24a0157fe09dd3f00cc65705316d5d6ba9c5f70cb9cfdaf466988486ec9793ac039b8b73697d1ef
+  data.tar.gz: 5560735ee50f49f582d4983f537a25829d93f6967fc5c3efe44e4fc20bb26b4e7eab2a1f5a23e70cccbc9e60184fcae867124705b16d671230d01595ea13bbfb

data/.circleci/config.yml

@@ -0,0 +1,20 @@
+version: 2
+jobs:
+  build_and_test:
+    docker:
+      - image: circleci/ruby:2.5
+        environment:
+          - RACK_ENV: test
+
+    steps:
+      - checkout
+
+      - run: bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - run: bundle exec rspec --backtrace
+
+workflows:
+  version: 2
+  test_and_deploy:
+    jobs:
+      - build_and_test

data/README.md

@@ -1,41 +1,91 @@
 # Sensible logging
 
-Proof of concept for some sensible defaults for logging in a Sinatra app.
+[![CircleCI](https://circleci.com/gh/madetech/sensible_logging.svg?style=svg)](https://circleci.com/gh/madetech/sensible_logging) [![Gem Version](https://badge.fury.io/rb/sensible_logging.png)](http://badge.fury.io/rb/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 library 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 (or use an existing if present `X-Request-Id`) request ID for use in logs
+* Trim the request logs to the bare minimal (inspired by lograge):
+  * method
+  * path
+  * requesting IP address
+  * status
+  * duration
+  * params if a `GET` request
+* Tagged logging, with some sensible defaults:
+  * subdomain
+  * environment
+  * unique request ID
+
+## Usage
+
+1. Add `sensible_logging` to your `Gemfile` and use `bundle install`.
+2. In `app.rb` register the module and then define your logging defaults.
+
+```ruby
+require 'sensible_logging'
 
-## Demo
+class App < Sinatra::Base
+  register Sinatra::SensibleLogging
 
-There is an example Sinatra app included in this repo, so:
+  sensible_logging(
+    logger: Logger.new(STDOUT)
+    )
 
+# 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**: `[]`
+
+## 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.
 
-## Using
+## 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.
 
-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/lib/sensible_logging/middlewares/request_logger.rb

@@ -12,7 +12,9 @@ class RequestLogger
     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?
     env['logger'].info(message)

data/lib/sensible_logging/middlewares/tagged_logger.rb

@@ -1,3 +1,4 @@
+require 'ipaddr'
 require 'active_support/tagged_logging'
 require_relative '../helpers/subdomain_parser'
 
@@ -22,13 +23,17 @@ class TaggedLogger
 
   def default_tags(tld_length: 1)
     [lambda { |req|
-      subdomain_parser = SubdomainParser.new(tld_length: tld_length)
-      subdomain = subdomain_parser.parse(req.host)
-
-      [subdomain || 'n/a', ENV['RACK_ENV'], req.env['request_id']]
+      [subdomain(req.host, tld_length) || 'n/a', ENV['RACK_ENV'], req.env['request_id']]
     }]
   end
 
+  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|

data/lib/sensible_logging/version.rb

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

data/lib/sensible_logging.rb

@@ -7,7 +7,7 @@ require_relative './sensible_logging/middlewares/request_logger'
 module Sinatra
   module SensibleLogging
     def sensible_logging(
-      logger:,
+      logger: Logger.new(STDOUT),
       log_tags: [],
       use_default_log_tags: true,
       exclude_params: [],

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensible_logging
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - David Winter
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -131,6 +131,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"