ougai 1.5.6 → 1.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0be28a9823a80734981fe6333f87b5369e61094
-  data.tar.gz: 4fee2e596d358d32409c86e46235539bfc796dee
+  metadata.gz: ceb8c682480975c5a3f5ab0da5f8336ad340d2f7
+  data.tar.gz: a23137a6d8297fb787a6b0c9b3ec50c2630d04d2
 SHA512:
-  metadata.gz: 1845cb73f37a0a48406f66d24dc68dcc2f6d6f4a161feaae880ab20557baf7bac77d1032fcfe131e028cd9e6c866f52949e3bf2e74dfdea0e728799912b5d2ea
-  data.tar.gz: ea9ac008a278ae1e879c5fdaf7080c9e2e0dbca1f781f4deade03c794eba36dd894d0bab6568c7a2d88681737a163cfa95b9801db7b5dbd566891071c8dbb170
+  metadata.gz: 41fd722562d4e09300b5048b7c74f540e4d54486f83e95fd722c16eb78e20334e3976e5441c63ae3d93c46508d5db81bcf06b867734b1d0b8cd6e4046e28d127
+  data.tar.gz: eedadc34fdae3207aceb6fb1aea85e3458e5d1fae44cb09da2117e8092289dcd89ab786ba0654c8bf0d5b607b08186ac21ce11b77e1dfb72f7d8d7ee1b78598f

data/README.md

@@ -351,6 +351,7 @@ logger.formatter = Ougai::Formatters::Readable.new
 - [Forward logs to Logentries](https://github.com/tilfin/ougai/wiki/Forward-logs-to-Logentries)
 - [Use as ServerEngine logger](https://github.com/tilfin/ougai/wiki/Use-as-ServerEngine-logger)
 - [Forward logs to Loggly](https://github.com/tilfin/ougai/wiki/Forward-logs-to-Loggly)
+- [Use as Rack logger](https://github.com/tilfin/ougai/wiki/Use-as-Rack-logger)
 
 ## License
 

data/lib/ougai/formatters/base.rb

@@ -3,8 +3,13 @@ require 'socket'
 
 module Ougai
   module Formatters
+    # Base formatter
+    # @attr [Fixnum] trace_indent Specify exception backtrace indent (by default this is 2).
+    # @attr [Fixnum] trace_max_lines Keep exception backtrace lines (by default this is 100).
+    # @attr [Boolean] serialize_backtrace Whether exception should converts String (by default this is on).
     class Base < Logger::Formatter
       attr_accessor :trace_indent, :trace_max_lines
+      attr_accessor :serialize_backtrace
       attr_reader :app_name, :hostname
 
       def initialize(app_name = nil, hostname = nil)
@@ -12,6 +17,7 @@ module Ougai
         @hostname = hostname || Socket.gethostname.force_encoding('UTF-8')
         @trace_indent = 2
         @trace_max_lines = 100
+        @serialize_backtrace = true
         self.datetime_format = nil
       end
 
@@ -25,14 +31,15 @@ module Ougai
           message: ex.to_s
         }
         if ex.backtrace
-          err[:stack] = serialize_trace(ex.backtrace)
+          bt = ex.backtrace.slice(0, @trace_max_lines)
+          err[:stack] = @serialize_backtrace ? serialize_trace(bt) : bt
         end
         err
       end
 
       def serialize_trace(trace)
         sp = "\n" + ' ' * @trace_indent
-        trace.slice(0, @trace_max_lines).join(sp)
+        trace.join(sp)
       end
 
       private

data/lib/ougai/formatters/readable.rb

@@ -14,6 +14,7 @@ module Ougai
         @trace_indent = opts[:trace_indent] || 4
         @plain = opts[:plain] || false
         @excluded_fields = opts[:excluded_fields] || []
+        @serialize_backtrace = true
         load_dependent
       end
 
@@ -28,6 +29,10 @@ module Ougai
         format_log_parts(dt, level, msg, err_str, data_str)
       end
 
+      def serialize_backtrace=(value)
+        raise RuntimeError, 'Not support serialize_backtrace'
+      end
+
       protected
 
       def format_log_parts(datetime, level, msg, err, data)
@@ -61,7 +66,7 @@ module Ougai
         return nil unless data.key?(:err)
         err = data.delete(:err)
         err_str = "  #{err[:name]} (#{err[:message]}):"
-        err_str += "\n    " + err[:stack] if err.key?(:stack)
+        err_str += "\n" + (" " * @trace_indent) + err[:stack] if err.key?(:stack)
         err_str
       end
 

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "1.5.6"
+  VERSION = "1.5.7"
 end

data/spec/formatters/base_spec.rb

@@ -64,4 +64,35 @@ describe Ougai::Formatters::Base do
       expect(subject.hostname).to eq('myhost')
     end
   end
+
+  describe '#serialize_exc' do
+    let (:app_name) { 'myapp' }
+    let (:hostname) { 'myhost' }
+    let (:errmsg) { 'dummy error' }
+
+    it 'returning data with stack as String' do
+      begin
+        raise errmsg
+      rescue => e
+        result = subject.serialize_exc(e)
+      end        
+      expect(result[:message]).to eq(errmsg)
+      expect(result[:stack]).to be_instance_of(String)
+    end
+
+    context 'not serialize backtrace' do
+      it 'returning data with stack as Array' do
+        subject.serialize_backtrace = false
+        subject.trace_max_lines = 6
+        begin
+          raise errmsg
+        rescue => e
+          result = subject.serialize_exc(e)
+        end        
+        expect(result[:message]).to eq(errmsg)
+        expect(result[:stack]).to be_instance_of(Array)
+        expect(result[:stack].size).to eq(6)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.5.7
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,17 +103,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: JSON logger compatible with node-bunyan is capable of handling structured
   data easily.
 test_files:
-- spec/child_logger_spec.rb
 - spec/formatters/base_spec.rb
 - spec/formatters/bunyan_spec.rb
 - spec/formatters/readable_spec.rb
-- spec/logger_spec.rb
+- spec/child_logger_spec.rb
 - spec/logging_spec.rb
+- spec/logger_spec.rb
 - spec/ougai_spec.rb
 - spec/spec_helper.rb