twiglet 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6970a1b98fbd77737c3742429691e3c03c7966e894e2f6a523824df785941858
-  data.tar.gz: 3a878416f432a4c9e38b0299afb6204fd2202168646d028298d40ab2c6cc7746
+  metadata.gz: 64fa676db51b4a53f17a7f1ff578ba00b670c2df9100b6972f2cf4b6fb51c1fc
+  data.tar.gz: 014044c6cccb28d13d019a26715ad83a5532e38b5f4df7ecf9a9a211eaec6751
 SHA512:
-  metadata.gz: 8a2e0c5bd321f495f4cf2c5d69a8caaff889e352305c5a900c1c7415e8637d0127729c91bd030353c1dd3b56e9c5623880f46849d3ff3eac1d502c3df8752c54
-  data.tar.gz: 0076c02f4070de277e488278f9f858d529b0ab39d8f8c07bc59a9d583c40421f0231b769a7ffb6a6ad1b422ed17f22ee4cd2a7eb68e436dc3b2b6c70c0246c8e
+  metadata.gz: 3d771c2182011b62d5d5af36a55fb04069a2f19805733df475b2f8d0e93e9ccdffdbac81c24eda8ba2081950812b94f87673c931776b65a125fb973106ce1210
+  data.tar.gz: 01c66f316cabc1b1169d35ca224d2c35f5e79efab580df3c530deaddcf30f8b23a46549ffc46140540408fc8c60c916ea72cb1c67122d32233b633786c8289c8

data/README.md

@@ -144,7 +144,72 @@ logger.formatter
 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.
 
-## Use of dotted keys (DEPRECATED)
+### 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:
 

data/lib/twiglet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema