twiglet 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f7e6901994e7715bab639be94853dbbcce697e16da26f2f8340404ebe4c0211
-  data.tar.gz: 1758572f62c689a68642cfb8887dc2ea380a3602332cf2321b06d51e80a7066d
+  metadata.gz: 9a94a60f7f04b8a19fd27f483e9f8e29992a237fa03491ad417a385032b98401
+  data.tar.gz: 976a134b1c69aa19956b5979affa35fc0141cb5164a8fa67a0aa91da1f490b2a
 SHA512:
-  metadata.gz: 808fb4ddbdaff2287331e022ec4a593469335a40476fa59cb0546facd126113c6b564f7538c3366984bb40ed178a131861b0a97e9ea571640caa68db0354a906
-  data.tar.gz: 83913e66900495ee39ba12d8f38e16e83fbc3621c4caf7bdaa128c6b44568f82face4498f1b2081e798ff6265b79a7758dd97eff08bd6224e8b0b7d077e8cb81
+  metadata.gz: 93c304efe8eeccbe2f6ed826499a288eee8d07897c79e1c0aca1f16e3908ea136a1731db7318228e5fa819b3cdafe6b196926a0fd1f9d387f94f7a315b0e868b
+  data.tar.gz: 74b4d3ec698510d3a236a159bf92fe1b0d07d6caf60fce91e46d24d89680ea5c93ffaee042606c5560d72709148756912d011405c113f51213f959c449d9e0ba

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
   Documentation:
     Enabled: false
 Metrics/BlockLength:
-  Max: 200
+  Max: 250
 Metrics/AbcSize:
   Max: 20
 Metrics/MethodLength:

data/README.md

@@ -40,6 +40,17 @@ This will write to STDOUT a JSON string:
 
 Obviously the timestamp will be different.
 
+Alternatively, if you just want to log some error message in text format
+```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"}
+```
+
 Errors can be logged as well, and this will log the error message and backtrace in the relevant ECS compliant fields:
 
 ```ruby
@@ -68,6 +79,18 @@ This writes:
 {"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 text 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

data/example_app.rb

@@ -17,6 +17,9 @@ logger.info({
               }
             })
 
+# Use text logging
+logger.info("Ready to go, listening on port #{PORT}")
+#
 # We get a request
 request_logger = logger.with({
                                event: {

data/lib/twiglet/logger.rb

@@ -55,6 +55,8 @@ module Twiglet
       log(level: 'critical', message: message)
     end
 
+    alias_method :fatal, :critical
+
     def with(default_properties)
       Logger.new(@service_name,
                  default_properties: default_properties,
@@ -65,27 +67,46 @@ module Twiglet
     private
 
     def log(level:, message:)
-      raise 'Message must be a Hash' unless message.is_a?(Hash)
+      case message
+      when String
+        log_text(level, message: message)
+      when Hash
+        log_object(level, message: message)
+      else
+        raise('Message must be String or Hash')
+      end
+    end
+
+    def log_text(level, message:)
+      raise('The \'message\' property of log object must not be empty') if message.strip.empty?
+
+      message = { message: message }
+      log_message(level, message: message)
+    end
 
+    def log_object(level, message:)
       message = message.transform_keys(&:to_sym)
       message.key?(:message) || raise('Log object must have a \'message\' property')
-
       message[:message].strip.empty? && raise('The \'message\' property of log object must not be empty')
 
+      log_message(level, message: message)
+    end
+
+    def log_message(level, message:)
       base_message = {
+        "@timestamp": @now.call.iso8601(3),
         service: {
           name: @service_name
         },
-        "@timestamp": @now.call.iso8601(3),
         log: {
           level: level
         }
       }
 
       @output.puts base_message
-                     .deep_merge(@default_properties.to_nested)
-                     .deep_merge(message.to_nested)
-                     .to_json
+                       .deep_merge(@default_properties.to_nested)
+                       .deep_merge(message.to_nested)
+                       .to_json
     end
   end
 end

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -12,191 +12,238 @@ describe Twiglet::Logger do
                                   output: @buffer)
   end
 
+  LEVELS = [
+    { method: :debug, level: 'debug' },
+    { method: :info, level: 'info' },
+    { method: :warning, level: 'warning' },
+    { method: :warn, level: 'warning' },
+    { method: :critical, level: 'critical' },
+    { method: :fatal, level: 'critical' },
+    { method: :error, level: 'error' }
+  ].freeze
+
   it 'should throw an error with an empty service name' do
     assert_raises RuntimeError do
       Twiglet::Logger.new('  ')
     end
   end
 
-  it 'should throw an error with an empty message' do
-    assert_raises RuntimeError do
-      @logger.info('')
+  describe 'JSON logging' do
+    it 'should throw an error with an empty message' do
+      assert_raises RuntimeError do
+        @logger.info({message: ''})
+      end
     end
-  end
 
-  it 'should log mandatory attributes' do
-    @logger.error({message: 'Out of pets exception'})
-    actual_log = read_json(@buffer)
-
-    expected_log = {
-      message: 'Out of pets exception',
-      "@timestamp": '2020-05-11T15:01:01.000Z',
-      service: {
-        name: 'petshop'
-      },
-      log: {
-        level: 'error'
+    it 'should log mandatory attributes' do
+      @logger.error({message: 'Out of pets exception'})
+      actual_log = read_json(@buffer)
+
+      expected_log = {
+        message: 'Out of pets exception',
+        "@timestamp": '2020-05-11T15:01:01.000Z',
+        service: {
+          name: 'petshop'
+        },
+        log: {
+          level: 'error'
+        }
       }
-    }
 
-    assert_equal expected_log, actual_log
-  end
+      assert_equal expected_log, actual_log
+    end
 
-  it 'should log the provided message' do
-    @logger.error({event:
-                     {action: 'exception'},
-                   message: 'Emergency! Emergency!'})
-    log = read_json(@buffer)
+    it 'should log the provided message' do
+      @logger.error({event:
+                       {action: 'exception'},
+                     message: 'Emergency! Emergency!'})
+      log = read_json(@buffer)
 
-    assert_equal 'exception', log[:event][:action]
-    assert_equal 'Emergency! Emergency!', log[:message]
-  end
+      assert_equal 'exception', log[:event][:action]
+      assert_equal 'Emergency! Emergency!', log[:message]
+    end
 
-  it 'should log scoped properties defined at creation' do
-    extra_properties = {
-      trace: {
-        id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'
-      },
-      service: {
-        type: 'shop'
-      },
-      request: {method: 'get'},
-      response: {status_code: 200}
-    }
-
-    output = StringIO.new
-    logger = Twiglet::Logger.new('petshop',
-                                 now: @now,
-                                 output: output,
-                                 default_properties: extra_properties)
-
-    logger.error({message: 'GET /cats'})
-    log = read_json output
-
-    assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
-    assert_equal 'petshop', log[:service][:name]
-    assert_equal 'shop', log[:service][:type]
-    assert_equal 'get', log[:request][:method]
-    assert_equal 200, log[:response][:status_code]
-  end
+    it 'should log scoped properties defined at creation' do
+      extra_properties = {
+        trace: {
+          id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'
+        },
+        service: {
+          type: 'shop'
+        },
+        request: {method: 'get'},
+        response: {status_code: 200}
+      }
 
-  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'}
-                                   })
-
-    # do stuff
-    purchase_logger.info({
-                           message: 'customer bought a dog',
-                           pet: {name: 'Barker', species: 'dog', breed: 'Bitsa'}
-                         })
-
-    log = read_json @buffer
-
-    assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
-    assert_equal 'Freda Bloggs', log[:customer][:full_name]
-    assert_equal 'pet purchase', log[:event][:action]
-    assert_equal 'customer bought a dog', log[:message]
-    assert_equal 'Barker', log[:pet][:name]
-  end
+      output = StringIO.new
+      logger = Twiglet::Logger.new('petshop',
+                                   now: @now,
+                                   output: output,
+                                   default_properties: extra_properties)
 
-  it "should log 'message' string property" do
-    message = {}
-    message['message'] = 'Guinea pigs arrived'
-    @logger.debug(message)
-    log = read_json(@buffer)
+      logger.error({message: 'GET /cats'})
+      log = read_json output
 
-    assert_equal 'Guinea pigs arrived', log[:message]
-  end
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'petshop', log[:service][:name]
+      assert_equal 'shop', log[:service][:type]
+      assert_equal 'get', log[:request][:method]
+      assert_equal 200, log[:response][:status_code]
+    end
 
-  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'
-                  })
-    log = read_json(@buffer)
-
-    assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
-    assert_equal 'customer bought a dog', log[:message]
-    assert_equal 'Barker', log[:pet][:name]
-    assert_equal 'dog', log[:pet][:species]
-    assert_equal 'Bitsa', log[:pet][:breed]
-  end
+    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'}
+                                     })
+
+      # do stuff
+      purchase_logger.info({
+                             message: 'customer bought a dog',
+                             pet: {name: 'Barker', species: 'dog', breed: 'Bitsa'}
+                           })
+
+      log = read_json @buffer
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'Freda Bloggs', log[:customer][:full_name]
+      assert_equal 'pet purchase', log[:event][:action]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+    end
 
-  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'
-                  })
-    log = read_json(@buffer)
-
-    assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
-    assert_equal 'customer bought a dog', log[:message]
-    assert_equal 'Barker', log[:pet][:name]
-    assert_equal 'dog', log[:pet][:species]
-    assert_equal 'Bitsa', log[:pet][:breed]
-  end
+    it "should log 'message' string property" do
+      message = {}
+      message['message'] = 'Guinea pigs arrived'
+      @logger.debug(message)
+      log = read_json(@buffer)
 
-  it 'should work with mixed string and symbol properties' do
-    log = {
-      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'
-    }
-    event = {}
-    log['event'] = event
-    log['message'] = 'customer bought a dog'
-    pet = {}
-    pet['name'] = 'Barker'
-    pet['breed'] = 'Bitsa'
-    pet[:species] = 'dog'
-    log[:pet] = pet
-
-    @logger.debug(log)
-    actual_log = read_json(@buffer)
-
-    assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', actual_log[:trace][:id]
-    assert_equal 'customer bought a dog', actual_log[:message]
-    assert_equal 'Barker', actual_log[:pet][:name]
-    assert_equal 'dog', actual_log[:pet][:species]
-    assert_equal 'Bitsa', actual_log[:pet][:breed]
-  end
+      assert_equal 'Guinea pigs arrived', log[:message]
+    end
 
-  it 'should log an error with backtrace' do
-    begin
-      1 / 0
-    rescue StandardError => e
-      @logger.error({message: 'Artificially raised exception'}, e)
+    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'
+                    })
+      log = read_json(@buffer)
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'dog', log[:pet][:species]
+      assert_equal 'Bitsa', log[:pet][:breed]
     end
 
-    actual_log = read_json(@buffer)
+    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'
+                    })
+      log = read_json(@buffer)
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'dog', log[:pet][:species]
+      assert_equal 'Bitsa', log[:pet][:breed]
+    end
 
-    assert_equal 'Artificially raised exception', actual_log[:message]
-    assert_equal 'divided by 0', actual_log[:error][:message]
-    assert_match 'logger_test.rb', actual_log[:error][:stack_trace].lines.first
+    it 'should work with mixed string and symbol properties' do
+      log = {
+        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'
+      }
+      event = {}
+      log['event'] = event
+      log['message'] = 'customer bought a dog'
+      pet = {}
+      pet['name'] = 'Barker'
+      pet['breed'] = 'Bitsa'
+      pet[:species] = 'dog'
+      log[:pet] = pet
+
+      @logger.debug(log)
+      actual_log = read_json(@buffer)
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', actual_log[:trace][:id]
+      assert_equal 'customer bought a dog', actual_log[:message]
+      assert_equal 'Barker', actual_log[:pet][:name]
+      assert_equal 'dog', actual_log[:pet][:species]
+      assert_equal 'Bitsa', actual_log[:pet][:breed]
+    end
+
+    it 'should log an error with backtrace' do
+      begin
+        1 / 0
+      rescue StandardError => e
+        @logger.error({message: 'Artificially raised exception'}, e)
+      end
+
+      actual_log = read_json(@buffer)
+
+      assert_equal 'Artificially raised exception', actual_log[:message]
+      assert_equal 'divided by 0', actual_log[:error][:message]
+      assert_match 'logger_test.rb', actual_log[:error][:stack_trace].lines.first
+    end
+
+    LEVELS.each do |attrs|
+      it "should correctly log level when calling #{attrs[:method]}" do
+        @logger.public_send(attrs[:method], {message: 'a log message'})
+        actual_log = read_json(@buffer)
+
+        assert_equal attrs[:level], actual_log[:log][:level]
+        assert_equal 'a log message', actual_log[:message]
+      end
+    end
   end
 
-  levels = [
-    { method: :debug, level: 'debug' },
-    { method: :info, level: 'info' },
-    { method: :warning, level: 'warning' },
-    { method: :warn, level: 'warning' },
-    { method: :error, level: 'error' }
-  ]
+  describe 'text logging' do
+    it 'should throw an error with an empty message' do
+      assert_raises RuntimeError do
+        @logger.info('')
+      end
+    end
 
-  levels.each do |attrs|
-    it "should correctly log level when calling #{attrs[:method]}" do
-      @logger.public_send(attrs[:method], {message: 'a log message'})
+    it 'should log mandatory attributes' do
+      @logger.error('Out of pets exception')
       actual_log = read_json(@buffer)
 
-      assert_equal attrs[:level], actual_log[:log][:level]
-      assert_equal 'a log message', actual_log[:message]
+      expected_log = {
+        message: 'Out of pets exception',
+        "@timestamp": '2020-05-11T15:01:01.000Z',
+        service: {
+          name: 'petshop'
+        },
+        log: {
+          level: 'error'
+        }
+      }
+
+      assert_equal expected_log, actual_log
+    end
+
+    it 'should log the provided message' do
+      @logger.error('Emergency! Emergency!')
+      log = read_json(@buffer)
+
+      assert_equal 'Emergency! Emergency!', log[:message]
+    end
+
+    LEVELS.each do |attrs|
+      it "should correctly log level when calling #{attrs[:method]}" do
+        @logger.public_send(attrs[:method], 'a log message')
+        actual_log = read_json(@buffer)
+
+        assert_equal attrs[:level], actual_log[:log][:level]
+        assert_equal 'a log message', actual_log[:message]
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Twiglet