twiglet 3.0.0 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3d278f5c152781abb779db8f28f7297f52c4d76db5358a78f13e784475f4851
-  data.tar.gz: bd8e3ae4b640ade3cb57489216cbdc7aec383f5535946c328352cc350057474c
+  metadata.gz: 44c51be445d04ae84c5289cbeaa7508b9d3f733ce7b8d5001c7925bd0ed44dd4
+  data.tar.gz: 2f04af22bf6c01fd12c8863e3c9350791d0d6c1ffaaf920797f9430e8e9d1e74
 SHA512:
-  metadata.gz: ef689b0df5314da2ddb0e5ed95a724d25f0f5c93f2f9647478d7f9eb60acb60b7b712c731b4118087d28f32685cc91bdb032f73e7438a822ad8fc7be7e742dd4
-  data.tar.gz: 2bc88df6d4f6a7cd4c0304eeafa199384054c58cc6f39629daec456605c72397302a49380f8bf681645654b030bc59b7d458ac45ca42091558711ea9980b6580
+  metadata.gz: 602d459a46ecb262457ba2b4cd3cb3900c3cdc77b3663087717018911bb61ef921e0892b7a24749182264e1e1ee970b9c92c72663ef0ed587a408de3863f8140
+  data.tar.gz: 342cc5eebdc1054be2ae04c434218eeb93902328bfbed79cf66df4d3445a6604206084d88aae4a5998656138e3edec4eb37421079c3d8a78a6a27f822f399860

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.6, 2.7]
+        ruby-version: [2.6, 2.7, 3.0]
 
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/version-forget-me-not.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-18.04
 
     steps:
-      - uses: simplybusiness/version-forget-me-not@v1
+      - uses: simplybusiness/version-forget-me-not@v2
         env:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION_FILE_PATH: "lib/twiglet/version.rb"

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/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/twiglet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.5
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-22 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"