hatchet 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3dbb2119f1401a7452c4a9fc14d9c4d6116992e
-  data.tar.gz: cf5a34782e06ff8d65104ac72c23d7d612f51263
+  metadata.gz: 8cbe273a0b241069c2de2607562f507b473bb2f8
+  data.tar.gz: 7fc75b084ea6f95ce11d3303d31a115eb11be899
 SHA512:
-  metadata.gz: 705e5334495aedd841228eb8aa51e1393c8e98936d8be1783f92a5536d08d43e3ab1f6ba89ea3197641f82d9d5af065234fe47ff29afdca60d3bad87f7132828
-  data.tar.gz: 4991d0d3761a20cb12eab7c45f4700bbc5f94a13607b1bf38f8320ae8ac9761e4081ab399f1bc3f84f127220021ddf1aba56aae436e4f6ae3150b54aa6bf713a
+  metadata.gz: ebf4aaeba91a3676b32c2227de90b1a140608020a2092b9ad232b83d6c62a4d19235151a2105dcf4b6390005220bafe1798839b13b5b053b79d0db291360cb9c
+  data.tar.gz: db44d98c902fabb1ad7d0231ab113acff8c6bbd99ecc5e17c9b8669386672a6424af0b1cb50eda30e1aefda01f847d1ac7c15d9d95fdd2a3dfe864009e7cdf64

data/RELEASE.md

@@ -1,22 +1,26 @@
 # Release notes
 
+## 0.2.11
+
+ * Railtie no longer tries to replace the asset logger when it is not present
+
 ## 0.2.10
 
-* Introduced the ability to filter backtraces
+ * Introduced the ability to filter backtraces
 
-Example:
+     Example:
 
-    configuration.configure do |config|
-      config.backtrace_filter '/applications/my_app/releases/current' => '[ROOT]'
-    end
+         configuration.configure do |config|
+           config.backtrace_filter '/applications/my_app/releases/current' => '[ROOT]'
+         end
 
-Will filter a backtrace line like:
+     Will filter a backtrace line like:
 
-    /applications/my_app/releases/current/lib/example.rb:42:in `main'
+         /applications/my_app/releases/current/lib/example.rb:42:in `main'
 
-Into:
+  Into:
 
-    [ROOT]/lib/example.rb:42:in `main'
+      [ROOT]/lib/example.rb:42:in `main'
 
 ## 0.2.9
 

data/lib/hatchet.rb

@@ -12,6 +12,7 @@ require_relative 'hatchet/nested_diagnostic_context'
 require_relative 'hatchet/plain_formatter'
 require_relative 'hatchet/simple_formatter'
 require_relative 'hatchet/standard_formatter'
+require_relative 'hatchet/structured_formatter'
 require_relative 'hatchet/version'
 
 # Public: Hatchet is a library for providing logging facilities whose levels are

data/lib/hatchet/hatchet_logger.rb

@@ -421,7 +421,7 @@ module Hatchet
       @configuration.appenders.any? do |appender|
         begin
           appender.enabled? level, @context
-        rescue => e
+        rescue
           puts "Failed to check if level #{level} enabled for #{context} with appender #{appender}\n"
           false
         end

data/lib/hatchet/message.rb

@@ -81,6 +81,8 @@ module Hatchet
     # block is preferred as it is assumed to provide more detail.
     #
     def initialize(args = {}, error = nil, &block)
+      @message = nil
+
       if args.kind_of? Hash
         # If args is a Hash then using new constructor format or no parameters
         # specified. Either way, use the new format.
@@ -101,7 +103,13 @@ module Hatchet
     # Public: Returns the String representation of the message.
     #
     def to_s
-      @evaluated_message ||= (@message || @block.call).to_s
+      evaluated_message.to_s
+    end
+
+    # Public: Returns the evaluated message.
+    #
+    def evaluated_message
+      @evaluated_message ||= (@message || @block.call)
     end
 
   end

data/lib/hatchet/nested_diagnostic_context.rb

@@ -152,6 +152,11 @@ module Hatchet
         end
       end
 
+      # Internal: Returns a copy of the stack as an array.
+      #
+      def to_a
+        @stack.clone.to_a
+      end
     end
 
   end

data/lib/hatchet/structured_formatter.rb

@@ -0,0 +1,104 @@
+# -*- encoding: utf-8 -*-
+
+require 'json'
+
+module Hatchet
+
+  # Public: Structured formatter class. Outputs messages as JSON strings.
+  #
+  class StructuredFormatter
+    include BacktraceFormatter
+
+    # Public: Creates a new instance.
+    #
+    def initialize
+      @backtrace = true
+      @secs = 0
+      @millis = -1
+      @level_cache = {}
+    end
+
+    # Public: Returns the formatted message.
+    #
+    # level   - The severity of the log message.
+    # context - The context of the log message.
+    # message - The message provided by the log caller.
+    #
+    # Returns messages in the format:
+    #
+    #   %Y-%m-%d %H:%M:%S.%L [THREAD] LEVEL CONTEXT - MESSAGE
+    #       BACKTRACE
+    #
+    # The backtrace is only present if the message contains an error.
+    #
+    def format(level, context, message)
+      msg = message.evaluated_message
+
+      case msg
+      when Hash
+        # Assume caller is following conventions
+        log = msg.dup
+      else
+        # Otherwise treat as String
+        log = { :message => msg.to_s.strip }
+      end
+
+      log[:timestamp] = timestamp
+      log[:level] = format_level(level)
+      log[:pid] = Process.pid
+
+      unless Thread.current == Thread.main
+        log[:thread] = Thread.current.object_id
+      end
+
+      log[:context] = context
+
+      if message.ndc.any?
+        log[:ndc] = message.ndc.to_a
+      end
+
+      if message.error
+        error = message.error
+
+        log[:error_class] = error.class.to_s
+        log[:error_message] = error.message
+        log[:error_backtrace]
+
+        if error.respond_to?(:backtrace)
+          backtrace = error.backtrace
+          backtrace = backtrace.take(backtrace_limit) if backtrace_limit
+          log[:error_backtrace] = backtrace
+        end
+      end
+
+      JSON.generate(log.to_h)
+    end
+
+    private
+
+    # Private: Returns the current time as a String.
+    #
+    def timestamp
+      time = Time.now.getutc
+
+      secs = time.to_i
+      millis = time.nsec/1000000
+
+      return @last if @millis == millis && @secs == secs
+
+      unless secs == @secs
+        @secs = secs
+        @date = time.strftime('%Y-%m-%d %H:%M:%S.')
+      end
+
+      @millis = millis
+      @last = @date + "00#{millis}"[-3..-1]
+    end
+
+    # Private: Returns the level formatted for log output as a String.
+    #
+    def format_level(level)
+      @level_cache[level] ||= level.to_s.upcase
+    end
+  end
+end

data/lib/hatchet/version.rb

@@ -4,6 +4,6 @@ module Hatchet
 
   # Public: The version of Hatchet.
   #
-  VERSION = '0.2.11'
+  VERSION = '0.2.12'
 
 end

data/spec/structured_formatter_spec.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'spec_helper'
+
+describe StructuredFormatter do
+  let(:subject) { StructuredFormatter.new }
+
+  describe 'when formatting a message' do
+    let(:log_message) { 'Hello, World' }
+
+    before do
+      ndc = NestedDiagnosticContext::ContextStack.new([:foo, 12])
+      @message = Message.new(ndc: ndc, message: log_message)
+      @context = 'Custom::Context'
+      @level   = :info
+      @formatted_message = subject.format(@level, @context, @message)
+    end
+
+    it "encodes the message as JSON" do
+      expected = {
+        "timestamp" => Time.now.getutc.strftime(TIME_FORMAT),
+        "level" => "INFO",
+        "pid" => Process.pid,
+        "context" => @context,
+        "ndc" => ["foo", 12],
+        "message" => @message.to_s.strip,
+      }
+
+      assert_equal JSON.parse(@formatted_message), expected
+    end
+
+    describe 'with an error' do
+      before do
+        error = OpenStruct.new(message: 'Boom!', backtrace: ['foo.rb:1:a', 'foo.rb:20:b'])
+        @message = Message.new(ndc: [], message: '  Hello, World  ', error: error)
+      end
+
+      it 'encodes the error' do
+        expected = {
+          "timestamp" => Time.now.getutc.strftime(TIME_FORMAT),
+          "level" => "INFO",
+          "pid" => Process.pid,
+          "context" => @context,
+          "message" => @message.to_s.strip,
+          "error_class" => "OpenStruct",
+          "error_message" => "Boom!",
+          "error_backtrace" => @message.error.backtrace,
+        }
+
+        formatted_message = subject.format(@level, @context, @message)
+
+        assert_equal JSON.parse(formatted_message), expected
+      end
+    end
+
+    describe 'with a structured message' do
+      let(:log_message) do
+        {
+          :message => "Hi, there",
+          :other => 123,
+        }
+      end
+
+      it "encodes the message as JSON" do
+        expected = {
+          "timestamp" => Time.now.getutc.strftime(TIME_FORMAT),
+          "level" => "INFO",
+          "pid" => Process.pid,
+          "context" => @context,
+          "ndc" => ["foo", 12],
+          "message" => log_message[:message],
+          "other" => log_message[:other],
+        }
+
+        assert_equal JSON.parse(@formatted_message), expected
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Garry Shutler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -49,6 +49,7 @@ files:
 - lib/hatchet/railtie.rb
 - lib/hatchet/simple_formatter.rb
 - lib/hatchet/standard_formatter.rb
+- lib/hatchet/structured_formatter.rb
 - lib/hatchet/thread_name_formatter.rb
 - lib/hatchet/version.rb
 - spec/configuration_spec.rb
@@ -67,6 +68,7 @@ files:
 - spec/simple_formatter_spec.rb
 - spec/spec_helper.rb
 - spec/standard_formatter_spec.rb
+- spec/structured_formatter_spec.rb
 homepage: http://gshutler.github.com/hatchet/
 licenses:
 - MIT
@@ -92,19 +94,20 @@ signing_key:
 specification_version: 4
 summary: Logging library that provides the ability to add class/module specific filters
 test_files:
+- spec/spec_helper.rb
+- spec/standard_formatter_spec.rb
+- spec/logger_spec.rb
+- spec/logger_appender_spec.rb
 - spec/configuration_spec.rb
+- spec/level_manager_spec.rb
+- spec/simple_formatter_spec.rb
+- spec/middleware_spec.rb
+- spec/message_spec.rb
+- spec/structured_formatter_spec.rb
+- spec/plain_formatter_spec.rb
+- spec/helpers/logger_double.rb
+- spec/helpers/test_formatter.rb
 - spec/helpers/disabled_appender.rb
 - spec/helpers/failing_appender.rb
-- spec/helpers/logger_double.rb
 - spec/helpers/storing_appender.rb
-- spec/helpers/test_formatter.rb
 - spec/include_spec.rb
-- spec/level_manager_spec.rb
-- spec/logger_appender_spec.rb
-- spec/logger_spec.rb
-- spec/message_spec.rb
-- spec/middleware_spec.rb
-- spec/plain_formatter_spec.rb
-- spec/simple_formatter_spec.rb
-- spec/spec_helper.rb
-- spec/standard_formatter_spec.rb