twiglet 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65c3f0028e0ac918736f63a2475fb45231586d51256a8778d4730ebd7792675c
-  data.tar.gz: 98d3607d5e1aad68f00d0ced7ccce24f0dba0c8b3eede84620a4a37a102a9849
+  metadata.gz: caa9b2047bc7a8ca268f0ba1b84a983b110234769db49c549f1d61fb21bbc730
+  data.tar.gz: c3eaa4009b34d4d01b4b0b7a90fc5ba1b2e760abb7b137fd92f4679c22de57ae
 SHA512:
-  metadata.gz: '0418346dbb4f5d486062caa13b7d1859a96309d00061b3e818563c9c399601f73035e2c89c64888e168d2a040fbb96c18a47e150c505859a58c067cfe46fe76f'
-  data.tar.gz: 9437cae3f2662746cd059a660f9e0884c5c0edd7e56de77771d81678c01f6e55006e048b50bd44f7a99d240b9a5d3527b70a15528d0f4e8711ca2e0954c73235
+  metadata.gz: d3ab7e57c1e99ac93349dcc2e75787e08d5f5c5fc6e242a03f286f17ae892ff38f759eacff900bbec46508fe559c5172958e1b94452e6af807e239ae195e29f2
+  data.tar.gz: 4c57202266f609af726de4cc9a60b38f9bcc414dbcdfb5ce26e7f39bb18ebb07f8292310a9fa6a853a49ab9a2f18d53837d77f2321c5046224884aa0b72c5f99

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.1'
+  VERSION = '3.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Twiglet