twiglet 2.4.0 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9eac4966bd34b02389637e38100f843f842fc115bad74d9480dc5b87a1dcad2
-  data.tar.gz: 3fb45d8d76a99246f4a215e42fa15dfa52b3f8f7cd8821edf8590653a114514c
+  metadata.gz: 501c866a8fafcb3a32d633ce10040ebecd946459a272c87fa925189fbc61caa4
+  data.tar.gz: 8bae82697cd8c606d82c7de19774de485ce0d87d524513de7ba50869218af4a8
 SHA512:
-  metadata.gz: 276587b79e63ad48de407c26ad113e64c6fb2819c991622f3f6ea50abe583853991a7f32ceafa4fc2008dff2a4ff4216766c53d0910ff8538ad26430474573f5
-  data.tar.gz: a963f5d218c7c8c327400245b122f83873201191c01828efa125418ea6e0b08d21c86a53ab791aedc9fb900a8642cb0e1130a835516388e922da6b00ccf83880
+  metadata.gz: a522314e822964fcda9508fa7c70456eecef93a89c51e5a43b8baa3d580de3dfc05a3872df8c81a9997825d011f058a6de38d33fe66967b7bbea1d6626c263c0
+  data.tar.gz: 83171f318329ac354dc0d5c823d192e1896b8d3f2cb6b6b927b13ec171174f366f89a4cb6f124752ac7bc2ca3d318e8ab8d87b87e0471ed8d911387c7ebafefe

data/.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "07:00"
+    open-pull-requests-limit: 99
+    labels:
+      - dependencies
+    ignore:
+      - dependency-name: simplecov
+        versions:
+          - ">= 0.18"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "07:00"
+    open-pull-requests-limit: 99
+    labels:
+      - dependencies

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.5, 2.6, 2.7]
+        ruby-version: [2.6, 2.7, 3.0]
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   simplycop: .simplycop.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   Rails:
     Enabled: false
   Documentation:

data/Gemfile

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-gem 'simplycop', git: 'https://github.com/simplybusiness/simplycop.git'
 group :development, :test do
   gem 'minitest'
   gem 'rake'
   gem 'simplecov', '0.17.1'
+  gem 'simplycop'
 end

data/README.md

@@ -11,13 +11,13 @@ gem install twiglet
 
 ## How to use
 
-Create a new logger like so:
+### Instantiate the logger
 
 ```ruby
 require 'twiglet/logger'
 logger = Twiglet::Logger.new('service name')
 ```
-
+#### Optional initialization parameters
 A hash can optionally be passed in as a keyword argument for `default_properties`. This hash must be in the Elastic Common Schema format and will be present in every log message created by this Twiglet logger object.
 
 You may also provide an optional `output` keyword argument which should be an object with a `puts` method - like `$stdout`.
@@ -28,7 +28,7 @@ Lastly, you may provide the optional keyword argument `level` to initialize the
 
 The defaults for both `output` and `now` should serve for most uses, though you may want to override them for testing as we have done [here](test/logger_test.rb).
 
-To use, simply invoke like most other loggers:
+### Invoke the Logger
 
 ```ruby
 logger.error({ event: { action: 'startup' }, message: "Emergency! There's an Emergency going on" })
@@ -56,6 +56,7 @@ This will write to STDOUT a JSON string:
 
 A message is always required unless a block is provided. The message can be an object or a string.
 
+#### Error logging
 An optional error can also be provided, in which case the error message and backtrace will be logged in the relevant ECS compliant fields:
 
 ```ruby
@@ -72,7 +73,8 @@ These will both result in the same JSON string written to STDOUT:
 {"ecs":{"version":"1.5.0"},"@timestamp":"2020-08-21T15:44:37.890Z","service":{"name":"service name"},"log":{"level":"error"},"message":"DB connection failed.","error":{"message":"Connection timed-out"}}
 ```
 
-Add log event specific information simply as attributes in a hash:
+#### Custom fields
+Log custom event-specific information simply as attributes in a hash:
 
 ```ruby
 logger.info({
@@ -129,6 +131,15 @@ which will print:
 {"service":{"name":"service name"},"@timestamp":"2020-05-14T10:58:30.780+01:00","log":{"level":"error"},"event":{"action":"HTTP request"},"trace":{"id":"126bb6fa-28a2-470f-b013-eefbf9182b2d"},"message":"Error 500 in /pets/buy","http":{"request":{"method":"post","url.path":"/pet/buy"},"response":{"status_code":500}}}
 ```
 
+### Log formatting
+Some third party applications will allow you to optionally specify a [log formatter](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger/Formatter.html).
+Supplying a Twiglet log formatter will format those third party logs so that they are ECS compliant and have the same default parameters as your application's internal logs.
+
+To access the formatter:
+```ruby
+logger.formatter
+```
+
 ## Use of dotted keys (DEPRECATED)
 
 Writing nested json objects could be confusing. This library has a built-in feature to convert dotted keys into nested objects, so if you log like this:

data/example_app.rb

@@ -8,27 +8,27 @@ logger = Twiglet::Logger.new('petshop')
 
 # Start our petshop
 logger.info({
-              event: {
-                action: 'startup'
-              },
-              message: "Ready to go, listening on port #{PORT}",
-              server: {
-                port: PORT
-              }
-            })
+  event: {
+    action: 'startup'
+  },
+  message: "Ready to go, listening on port #{PORT}",
+  server: {
+    port: PORT
+  }
+})
 
 # Use text logging
 logger.info("Ready to go, listening on port #{PORT}")
 #
 # We get a request
 request_logger = logger.with({
-                               event: {
-                                 action: 'HTTP request'
-                               },
-                               trace: {
-                                 id: '126bb6fa-28a2-470f-b013-eefbf9182b2d'
-                               }
-                             })
+  event: {
+    action: 'HTTP request'
+  },
+  trace: {
+    id: '126bb6fa-28a2-470f-b013-eefbf9182b2d'
+  }
+})
 
 # Oh noes!
 db_err = StandardError.new('Connection timed-out')
@@ -37,16 +37,16 @@ request_logger.error({ message: 'DB connection failed.' }, db_err) if db_err
 
 # We return an error to the requester
 request_logger.info({
-                      message: 'Internal Server Error',
-                      http: {
-                        request: {
-                          method: 'get'
-                        },
-                        response: {
-                          status_code: 500
-                        }
-                      }
-                    })
+  message: 'Internal Server Error',
+  http: {
+    request: {
+      method: 'get'
+    },
+    response: {
+      status_code: 500
+    }
+  }
+})
 
 # Logging with an empty message is an anti-pattern and is therefore forbidden
 # Both of the following lines would throw an error

data/examples/rack/request_logger.rb

@@ -11,7 +11,7 @@ class RequestLogger
     [status, headers, body]
   rescue StandardError => e
     log_error(env, 500, e)
-    [500, {}, body]
+    raise e
   end
 
   private
@@ -26,24 +26,41 @@ class RequestLogger
     @logger.error(fields, error)
   end
 
+  # https://www.elastic.co/guide/en/ecs/1.5/ecs-field-reference.html
   def get_fields(env, status)
     message = "#{env['REQUEST_METHOD']}: #{env['PATH_INFO']}"
 
     {
-      http: {
-        request: {
-          method: env['REQUEST_METHOD'],
-          server: env['SERVER_NAME'],
-          https_enabled: env['HTTPS'],
-          path: env['PATH_INFO'],
-          query: env['QUERY_STRING']  # Don't log PII query params
-        },
-        response: {
-          status: status,
-          body: { bytes: env['CONTENT_LENGTH'] }
-        }
+      http: http_fields(env, status),
+      url: url_fields(env),
+      client: {
+        ip: env['HTTP_TRUE_CLIENT_IP'] || env['REMOTE_ADDR']
+      },
+      user_agent: {
+        original: env['HTTP_USER_AGENT']
       },
       message: message
     }
   end
+
+  def http_fields(env, status)
+    {
+      request: {
+        method: env['REQUEST_METHOD'],
+        mime_type: env['HTTP_ACCEPT']
+      },
+      response: {
+        status: status
+      },
+      version: env['HTTP_VERSION']
+    }
+  end
+
+  def url_fields(env)
+    {
+      path: env['PATH_INFO'],
+      query: env['QUERY_STRING'],
+      domain: env['SERVER_NAME']
+    }
+  end
 end

data/examples/rack/request_logger_test.rb

@@ -1,4 +1,5 @@
 require 'minitest/autorun'
+require_relative '../../lib/twiglet/logger'
 require_relative './request_logger'
 require 'rack'
 
@@ -14,23 +15,43 @@ describe RequestLogger do
   end
 
   it 'logs the request data' do
-    request.get("/some/path?some_var=1")
+    request.get("/some/path?some_var=1", 'HTTP_ACCEPT' => 'application/json',
+                                         'REMOTE_ADDR' => '0.0.0.0',
+                                         'HTTP_VERSION' => 'HTTP/1.1',
+                                         'HTTP_USER_AGENT' => 'Mozilla/5.0 (Macintosh)')
     log = JSON.parse(output.string)
-    http_body = {
-      "request" => {
-        "https_enabled" => "off",
-        "method" => "GET",
+
+    expected_log = {
+      "log" => { "level" => "info" },
+      "http" => {
+        "request" => {
+          "method" => "GET",
+          "mime_type" => 'application/json'
+        },
+        "response" => {
+          "status" => 200
+        },
+        "version" => 'HTTP/1.1'
+      },
+      "url" => {
         "path" => "/some/path",
         "query" => "some_var=1",
-        "server" => "example.org"
+        "domain" => "example.org"
+      },
+      "client" => {
+        'ip' => '0.0.0.0'
       },
-      "response" => {
-        "status" => 200,
-        "body" => { "bytes" => "0" }
-      }
+      "user_agent" => {
+        "original" => 'Mozilla/5.0 (Macintosh)'
+      },
+      "message" => "GET: /some/path"
     }
-    assert_equal http_body, log["http"]
-    assert_equal "GET: /some/path", log["message"]
+
+    assert_equal(log['log'], expected_log['log'])
+    assert_equal(log['http'], expected_log['http'])
+    assert_equal(log['url'], expected_log['url'])
+    assert_equal(log['user_agent'], expected_log['user_agent'])
+    assert_equal(log['message'], expected_log['message'])
   end
 
   it 'does not log PII' do
@@ -42,10 +63,12 @@ describe RequestLogger do
   end
 
   it 'logs an error message when a request is bad' do
-    bad_request.get("/some/path")
+    -> { bad_request.get("/some/path") }.must_raise StandardError
     log = JSON.parse(output.string)
-    assert_equal 'error', log['log']['level']
-    assert_equal 'some exception', log['error']['message']
+    assert_equal log['log']['level'], 'error'
+    assert_equal log['error']['message'], 'some exception'
+    assert_equal log['error']['type'], 'StandardError'
+    assert_includes log['error']['stack_trace'], 'request_logger_test.rb'
   end
 end
 

data/lib/hash_extensions.rb

@@ -22,8 +22,8 @@ module HashExtensions
 
   def build_nested_object(key, val)
     key.to_s
-      .split('.')
-      .reverse
-      .reduce(val) { |nested, key_part| Hash[key_part.to_sym, nested] }
+       .split('.')
+       .reverse
+       .reduce(val) { |nested, key_part| Hash[key_part.to_sym, nested] }
   end
 end

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '2.4.0'
+  VERSION = '3.0.4'
 end

data/test/logger_test.rb

@@ -3,6 +3,16 @@
 require 'minitest/autorun'
 require_relative '../lib/twiglet/logger'
 
+LEVELS = [
+  { method: :debug, level: 'debug' },
+  { method: :info, level: 'info' },
+  { method: :warning, level: 'warn' },
+  { method: :warn, level: 'warn' },
+  { method: :critical, level: 'fatal' },
+  { method: :fatal, level: 'fatal' },
+  { method: :error, level: 'error' }
+].freeze
+
 # rubocop:disable Metrics/BlockLength
 describe Twiglet::Logger do
   before do
@@ -13,16 +23,6 @@ describe Twiglet::Logger do
                                   output: @buffer)
   end
 
-  LEVELS = [
-    { method: :debug, level: 'debug' },
-    { method: :info, level: 'info' },
-    { method: :warning, level: 'warn' },
-    { method: :warn, level: 'warn' },
-    { method: :critical, level: 'fatal' },
-    { method: :fatal, level: 'fatal' },
-    { method: :error, level: 'error' }
-  ].freeze
-
   it 'should throw an error with an empty service name' do
     assert_raises RuntimeError do
       Twiglet::Logger.new('  ')
@@ -105,16 +105,16 @@ describe Twiglet::Logger do
     it "should be able to add properties with '.with'" do
       # Let's add some context to this customer journey
       purchase_logger = @logger.with({
-                                       trace: {id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'},
-                                       customer: {full_name: 'Freda Bloggs'},
-                                       event: {action: 'pet purchase'}
-                                     })
+        trace: {id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'},
+        customer: {full_name: 'Freda Bloggs'},
+        event: {action: 'pet purchase'}
+      })
 
       # do stuff
       purchase_logger.info({
-                             message: 'customer bought a dog',
-                             pet: {name: 'Barker', species: 'dog', breed: 'Bitsa'}
-                           })
+        message: 'customer bought a dog',
+        pet: {name: 'Barker', species: 'dog', breed: 'Bitsa'}
+      })
 
       log = read_json @buffer
 
@@ -285,12 +285,12 @@ describe Twiglet::Logger do
   describe 'dotted keys' do
     it 'should be able to convert dotted keys to nested objects' do
       @logger.debug({
-                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-                      message: 'customer bought a dog',
-                      "pet.name": 'Barker',
-                      "pet.species": 'dog',
-                      "pet.breed": 'Bitsa'
-                    })
+        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+        message: 'customer bought a dog',
+        "pet.name": 'Barker',
+        "pet.species": 'dog',
+        "pet.breed": 'Bitsa'
+      })
       log = read_json(@buffer)
 
       assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
@@ -302,11 +302,11 @@ describe Twiglet::Logger do
 
     it 'should be able to mix dotted keys and nested objects' do
       @logger.debug({
-                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-                      message: 'customer bought a dog',
-                      pet: {name: 'Barker', breed: 'Bitsa'},
-                      "pet.species": 'dog'
-                    })
+        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+        message: 'customer bought a dog',
+        pet: {name: 'Barker', breed: 'Bitsa'},
+        "pet.species": 'dog'
+      })
       log = read_json(@buffer)
 
       assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]

data/twiglet.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files            = `git ls-files -- {test}/*`.split("\n")
 
   gem.require_paths         = ['lib']
-  gem.required_ruby_version = '>= 2.5'
+  gem.required_ruby_version = '>= 2.6'
 
   gem.license               = 'Copyright SimplyBusiness'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.4
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/dependabot.yml"
 - ".github/workflows/gem-publish.yml"
 - ".github/workflows/ruby.yml"
 - ".github/workflows/version-forget-me-not.yml"
@@ -59,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Twiglet