twiglet 3.2.4 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5e306c5c4dc2c68643563adb8a8afbab99adb3c9b0b2d2bc9c470abab942da
-  data.tar.gz: 102e368540fd555ccb5cf6f894424f95ffbdd09d59a175863155d761682f8307
+  metadata.gz: 9deeab3ebe1ca91277b1eaec6980a61e5bb4434ae4a8c4ee7025f2ead0bed7e3
+  data.tar.gz: 0c18af6ba979be04841730db5ee2418037d8e77728d5ee1495bce4522fee334b
 SHA512:
-  metadata.gz: fc9162c419bc88716f1b2a97a37a39a9e59ec993b247607a245a63c2cfaf45a03e311a89c21becacd61d4cd67247aa4706878723039990c3267a39747d3aa6ac
-  data.tar.gz: 27108b86694c9cece08ce478b17ee570c8bb440c5b5421ee936176950b937e0d8af4745228a9cb96bd1906a172e9502b5ca911f5259ac95fa6decb904f0e9dab
+  metadata.gz: 25a067c8e8ab1f751b5ffcec83542da3fac87aaeec59456938dfd3b33a6a6b9b0be5890b5ab4456ee7081ddc111d1953d23b86e4bf4931540515ab64838c1c2b
+  data.tar.gz: 379a36f5274f6025bdcefb48ea6e51db39ad4d8e675c21e87efb59adbc0e42829146bfc2c07f39dd5faa40ce61e554d051a54ad1eca4e2258b282a55638d271a

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@v2.0.1
+      - uses: simplybusiness/version-forget-me-not@V2.1.1
         env:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION_FILE_PATH: "lib/twiglet/version.rb"

data/README.md

@@ -3,254 +3,4 @@ Like a log, only smaller.
 
 This library provides a minimal JSON logging interface suitable for use in (micro)services.  See the [RATIONALE](RATIONALE.md) for design rationale and an explantion of the Elastic Common Schema that we are using for log attribute naming.
 
-## Installation
-
-```bash
-gem install twiglet
-```
-
-## How to use
-
-### 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`.
-
-In addition, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
-
-Lastly, you may provide the optional keyword argument `level` to initialize the logger with a severity threshold. Alternatively, the threshold can be updated at runtime by calling the `level` instance method.
-
-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).
-
-### Invoke the Logger
-
-```ruby
-logger.error({ event: { action: 'startup' }, message: "Emergency! There's an Emergency going on" })
-```
-
-This will write to STDOUT a JSON string:
-
-```json
-{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:54:59.164+01:00","log":{"level":"error"},"event":{"action":"startup"},"message":"Emergency! There's an Emergency going on"}
-```
-
-Obviously the timestamp will be different.
-
-Alternatively, if you just want to log some error string:
-
-```ruby
-logger.error("Emergency! There's an Emergency going on")
-```
-
-This will write to STDOUT a JSON string:
-
-```json
-{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:54:59.164+01:00","log":{"level":"error"}, "message":"Emergency! There's an Emergency going on"}
-```
-
-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
-db_err = StandardError.new('Connection timed-out')
-logger.error({ message: 'DB connection failed.' }, db_err)
-
-# this is also valid
-logger.error('DB connection failed.', db_err)
-```
-
-These will both result in the same JSON string written to STDOUT:
-
-```json
-{"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"}}
-```
-
-#### Custom fields
-Log custom event-specific information simply as attributes in a hash:
-
-```ruby
-logger.info({
-  event: { action: 'HTTP request' },
-  message: 'GET /pets success',
-  trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' },
-  http: {
-    request: { method: 'get' },
-    response: { status_code: 200 }
-  },
-  url: { path: '/pets' }
-})
-```
-
-This writes:
-
-```json
-{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:56:49.527+01:00","log":{"level":"info"},"event":{"action":"HTTP request"},"message":"GET /pets success","trace":{"id":"1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb"},"http":{"request":{"method":"get"},"response":{"status_code":200}},"url":{"path":"/pets"}}
-```
-
-Similar to error you can use string logging here as:
-
-```
-logger.info('GET /pets success')
-```
-
-This writes:
-
-```json
-{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:56:49.527+01:00","log":{"level":"info"}}
-```
-
-It may be that when making a series of logs that write information about a single event, you may want to avoid duplication by creating an event specific logger that includes the context:
-
-```ruby
-request_logger = logger.with({ event: { action: 'HTTP request'}, trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' }})
-```
-
-This can be used like any other Logger instance:
-
-```ruby
-request_logger.error({
-    message: 'Error 500 in /pets/buy',
-    http: {
-        request: { method: 'post', 'url.path': '/pet/buy' },
-        response: { status_code: 500 }
-    }
-})
-```
-
-which will print:
-
-```json
-{"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
-```
-
-### HTTP Request Logging
-Take a look at this sample [Rack application](examples/rack/example_rack_app.rb#L15) with an ECS compliant
-[request logger](/examples/rack/request_logger.rb) as a template when configuring your own request logging middleware with Twiglet.
-
-### Log format validation
-Twiglet allows for the configuration of a custom validation schema. The validation schema must be [JSON Schema](https://json-schema.org/) compliant. Any fields not explicitly included in the provided schema are permitted by default.
-
-For example, given the following JSON Schema:
-```ruby
-validation_schema = <<-JSON
-    {
-      "type": "object",
-      "required": ["pet"],
-      "properties": {
-        "pet": {
-          "type": "object",
-          "required": ["name", "best_boy_or_girl?"],
-          "properties": {
-            "name": {
-              "type": "string",
-              "minLength": 1
-            },
-            "good_boy?": {
-              "type": "boolean"
-            }
-          }
-        }
-      }
-    }
-JSON
-```
-
-The logger can be instantiated with the custom schema
-```ruby
-custom_logger = Twiglet::Logger.new('service name', validation_schema: validation_schema)
-```
-
-Compliant log messages will log as normal.
-```ruby
-# this is compliant
-custom_logger.debug(pet: { name: 'Davis', good_boy?: true })
-
-# the result
-{:ecs=>{:version=>"1.5.0"}, :@timestamp=>"2020-05-11T15:01:01.000Z", :service=>{:name=>"petshop"}, :log=>{:level=>"debug"}, :pet=>{:name=>"Davis", :good_boy?=>true}}
-```
-
-Non compliant messages will raise an error.
-```ruby
-begin
-  custom_logger.debug(pet: { name: 'Davis' })
-rescue JSON::Schema::ValidationError
-  # we forgot to specify that he's a good boy!
-  puts 'uh-oh'
-end
-```
-
-#### Customizing error responses
-Depending on the application, it may not be desirable for the logger to raise Runtime errors. Twiglet allows you to configure a custom response for handling validation errors.
-
-Configure error handling by writing a block
-```ruby
-logger.configure_validation_error_response do |error|
-  # validation error handling goes here
-  # for example:
-  {YOUR APPLICATION BUG TRACKING SERVICE}.notify_error(error)
-end
-
-```
-
-### 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:
-
-```ruby
-logger.info({
-    'event.action': 'HTTP request',
-    message: 'GET /pets success',
-    'trace.id': '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-    'http.request.method': 'get',
-    'http.response.status_code': 200,
-    'url.path': '/pets'
-})
-```
-
-or mix between dotted keys and nested objects:
-
-```ruby
-logger.info({
-    'event.action': 'HTTP request',
-    message: 'GET /pets success',
-    trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' },
-    'http.request.method': 'get',
-    'http.response.status_code': 200,
-    url: { path: '/pets' }
-})
-```
-
-Both cases would print out exact the same log item:
-
-```json
-{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:59:31.183+01:00","log":{"level":"info"},"event":{"action":"HTTP request"},"message":"GET /pets success","trace":{"id":"1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb"},"http":{"request":{"method":"get"},"response":{"status_code":200}},"url":{"path":"/pets"}}
-```
-
-## How to contribute
-
-First: Please read our project [Code of Conduct](../CODE_OF_CONDUCT.md).
-
-Second: run the tests and make sure your changes don't break anything:
-
-```bash
-bundle exec rake test
-```
-
-Then please feel free to submit a PR.
+See [Full docs](docs/index.md)

data/catalog-info.yaml

@@ -0,0 +1,16 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: twiglet
+  description: simple logging
+  annotations:
+    github.com/project-slug: "simplybusiness/twiglet-ruby"
+    backstage.io/source-location: url:https://github.com/simplybusiness/twiglet-ruby/
+    backstage.io/techdocs-ref: url:https://github.com/simplybusiness/twiglet-ruby/
+spec:
+  type: library
+  lifecycle: production
+  owner: silversmiths
+  dependsOn:
+    - "Component:json-schema"
+    - "Component:simplycop"

data/{RATIONALE.md → docs/RATIONALE.md}

@@ -87,4 +87,4 @@ Please see the [code of conduct](CODE_OF_CONDUCT.md) for further info.
 
 # License
 
-This work is licensed under the MIT license - see the [LICENSE](LICENSE) file for further details.
+This work is licensed under the MIT license - see the [LICENSE](../LICENSE) file for further details.

data/docs/index.md

@@ -0,0 +1,256 @@
+# Twiglet: Ruby version
+Like a log, only smaller.
+
+This library provides a minimal JSON logging interface suitable for use in (micro)services.  See the [RATIONALE](docs/RATIONALE.md) for design rationale and an explantion of the Elastic Common Schema that we are using for log attribute naming.
+
+## Installation
+
+```bash
+gem install twiglet
+```
+
+## How to use
+
+### 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`.
+
+In addition, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
+
+Lastly, you may provide the optional keyword argument `level` to initialize the logger with a severity threshold. Alternatively, the threshold can be updated at runtime by calling the `level` instance method.
+
+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).
+
+### Invoke the Logger
+
+```ruby
+logger.error({ event: { action: 'startup' }, message: "Emergency! There's an Emergency going on" })
+```
+
+This will write to STDOUT a JSON string:
+
+```json
+{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:54:59.164+01:00","log":{"level":"error"},"event":{"action":"startup"},"message":"Emergency! There's an Emergency going on"}
+```
+
+Obviously the timestamp will be different.
+
+Alternatively, if you just want to log some error string:
+
+```ruby
+logger.error("Emergency! There's an Emergency going on")
+```
+
+This will write to STDOUT a JSON string:
+
+```json
+{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:54:59.164+01:00","log":{"level":"error"}, "message":"Emergency! There's an Emergency going on"}
+```
+
+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
+db_err = StandardError.new('Connection timed-out')
+logger.error({ message: 'DB connection failed.' }, db_err)
+
+# this is also valid
+logger.error('DB connection failed.', db_err)
+```
+
+These will both result in the same JSON string written to STDOUT:
+
+```json
+{"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"}}
+```
+
+#### Custom fields
+Log custom event-specific information simply as attributes in a hash:
+
+```ruby
+logger.info({
+  event: { action: 'HTTP request' },
+  message: 'GET /pets success',
+  trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' },
+  http: {
+    request: { method: 'get' },
+    response: { status_code: 200 }
+  },
+  url: { path: '/pets' }
+})
+```
+
+This writes:
+
+```json
+{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:56:49.527+01:00","log":{"level":"info"},"event":{"action":"HTTP request"},"message":"GET /pets success","trace":{"id":"1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb"},"http":{"request":{"method":"get"},"response":{"status_code":200}},"url":{"path":"/pets"}}
+```
+
+Similar to error you can use string logging here as:
+
+```
+logger.info('GET /pets success')
+```
+
+This writes:
+
+```json
+{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:56:49.527+01:00","log":{"level":"info"}}
+```
+
+It may be that when making a series of logs that write information about a single event, you may want to avoid duplication by creating an event specific logger that includes the context:
+
+```ruby
+request_logger = logger.with({ event: { action: 'HTTP request'}, trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' }})
+```
+
+This can be used like any other Logger instance:
+
+```ruby
+request_logger.error({
+    message: 'Error 500 in /pets/buy',
+    http: {
+        request: { method: 'post', 'url.path': '/pet/buy' },
+        response: { status_code: 500 }
+    }
+})
+```
+
+which will print:
+
+```json
+{"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
+```
+
+### HTTP Request Logging
+Take a look at this sample [Rack application](examples/rack/example_rack_app.rb#L15) with an ECS compliant
+[request logger](/examples/rack/request_logger.rb) as a template when configuring your own request logging middleware with Twiglet.
+
+### Log format validation
+Twiglet allows for the configuration of a custom validation schema. The validation schema must be [JSON Schema](https://json-schema.org/) compliant. Any fields not explicitly included in the provided schema are permitted by default.
+
+For example, given the following JSON Schema:
+```ruby
+validation_schema = <<-JSON
+    {
+      "type": "object",
+      "required": ["pet"],
+      "properties": {
+        "pet": {
+          "type": "object",
+          "required": ["name", "best_boy_or_girl?"],
+          "properties": {
+            "name": {
+              "type": "string",
+              "minLength": 1
+            },
+            "good_boy?": {
+              "type": "boolean"
+            }
+          }
+        }
+      }
+    }
+JSON
+```
+
+The logger can be instantiated with the custom schema
+```ruby
+custom_logger = Twiglet::Logger.new('service name', validation_schema: validation_schema)
+```
+
+Compliant log messages will log as normal.
+```ruby
+# this is compliant
+custom_logger.debug(pet: { name: 'Davis', good_boy?: true })
+
+# the result
+{:ecs=>{:version=>"1.5.0"}, :@timestamp=>"2020-05-11T15:01:01.000Z", :service=>{:name=>"petshop"}, :log=>{:level=>"debug"}, :pet=>{:name=>"Davis", :good_boy?=>true}}
+```
+
+Non compliant messages will raise an error.
+```ruby
+begin
+  custom_logger.debug(pet: { name: 'Davis' })
+rescue JSON::Schema::ValidationError
+  # we forgot to specify that he's a good boy!
+  puts 'uh-oh'
+end
+```
+
+#### Customizing error responses
+Depending on the application, it may not be desirable for the logger to raise Runtime errors. Twiglet allows you to configure a custom response for handling validation errors.
+
+Configure error handling by writing a block
+```ruby
+logger.configure_validation_error_response do |error|
+  # validation error handling goes here
+  # for example:
+  {YOUR APPLICATION BUG TRACKING SERVICE}.notify_error(error)
+end
+
+```
+
+### 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:
+
+```ruby
+logger.info({
+    'event.action': 'HTTP request',
+    message: 'GET /pets success',
+    'trace.id': '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+    'http.request.method': 'get',
+    'http.response.status_code': 200,
+    'url.path': '/pets'
+})
+```
+
+or mix between dotted keys and nested objects:
+
+```ruby
+logger.info({
+    'event.action': 'HTTP request',
+    message: 'GET /pets success',
+    trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' },
+    'http.request.method': 'get',
+    'http.response.status_code': 200,
+    url: { path: '/pets' }
+})
+```
+
+Both cases would print out exact the same log item:
+
+```json
+{"service":{"name":"service name"},"@timestamp":"2020-05-14T10:59:31.183+01:00","log":{"level":"info"},"event":{"action":"HTTP request"},"message":"GET /pets success","trace":{"id":"1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb"},"http":{"request":{"method":"get"},"response":{"status_code":200}},"url":{"path":"/pets"}}
+```
+
+## How to contribute
+
+First: Please read our project [Code of Conduct](../CODE_OF_CONDUCT.md).
+
+Second: run the tests and make sure your changes don't break anything:
+
+```bash
+bundle exec rake test
+```
+
+Then please feel free to submit a PR.

data/examples/rack/request_logger_test.rb

@@ -70,7 +70,7 @@ describe RequestLogger do
     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'
+    assert_includes log['error']['stack_trace'].first, 'examples/rack/request_logger_test.rb'
   end
 end
 

data/lib/twiglet/logger.rb

@@ -70,7 +70,7 @@ module Twiglet
     private
 
     def add_stack_trace(hash_to_add_to, error)
-      hash_to_add_to[:error][:stack_trace] = error.backtrace.join("\n") if error.backtrace
+      hash_to_add_to[:error][:stack_trace] = error.backtrace if error.backtrace
     end
   end
 end

data/lib/twiglet/version.rb

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

data/mkdocs.yml

@@ -0,0 +1,8 @@
+site_name: 'Twiglet Docs'
+nav:
+  - Home: index.md
+  - Code of Conduct: CODE_OF_CONDUCT.md
+  - "Why Twiglet?": RATIONALE.md
+
+plugins:
+  - techdocs-core

data/test/logger_test.rb

@@ -217,7 +217,7 @@ describe Twiglet::Logger do
       assert_equal 'Artificially raised exception', actual_log[:message]
       assert_equal 'divided by 0', actual_log[:error][:message]
       assert_equal 'ZeroDivisionError', actual_log[:error][:type]
-      assert_match 'logger_test.rb', actual_log[:error][:stack_trace].lines.first
+      assert_match 'test/logger_test.rb', actual_log[:error][:stack_trace].first
     end
 
     it 'should log an error without backtrace' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.2.4
+  version: 3.3.3
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -96,14 +96,16 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
 - LICENSE
 - Makefile
-- RATIONALE.md
 - README.md
 - Rakefile
+- catalog-info.yaml
+- docs/CODE_OF_CONDUCT.md
+- docs/RATIONALE.md
+- docs/index.md
 - example_app.rb
 - examples/rack/example_rack_app.rb
 - examples/rack/request_logger.rb
@@ -115,6 +117,7 @@ files:
 - lib/twiglet/validation_schema.json
 - lib/twiglet/validator.rb
 - lib/twiglet/version.rb
+- mkdocs.yml
 - test/formatter_test.rb
 - test/hash_extensions_test.rb
 - test/logger_test.rb
@@ -141,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Twiglet