structured_logger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ce68b01c710f32eb7c7aa152f407e1ba124e6f4
-  data.tar.gz: 5f5ab981b8f41b2ac436ec000fff1f23135d9207
+  metadata.gz: 6ebc7ffd6ba59caa43ceafbb4bbfbdd9e5024ac2
+  data.tar.gz: 3dfecb3f06b04ca4a363016857a9383dcb378a09
 SHA512:
-  metadata.gz: 40fd946186fcf0d3a4a513cf68d5483519f6f36a107bb5827a516cb71069e9a34c285413a4050545addfc8efaa672b4dbc19e84d1a3bebcae386a38092a071cb
-  data.tar.gz: 5ef933b506c400e0363375c7ea29752d20df272826673110c5f9cb612d4952809fad7b826d28d65b57f78b4c662e8376d9da02ecda64f50746d8b39afaf9f46d
+  metadata.gz: e712c962c7cf95483f6b134be48790053dc8b57d1a473d5fcb5a36e4f5539aca0fcffe498e079dad5b8a11bf4f1ec482b088219fc243a6876a74e2e749eba589
+  data.tar.gz: c928328bedea1f3cd87960e6f9e1f9ee36b927bd08b4711d3df70291b912d77c164bcc1a985cbd26db8718ade6e9bb8435aeb4e6a0866af9f8787b8be73ea7aa

data/README.md

@@ -50,6 +50,18 @@ l.error("Something happend")
 #=> E, [2015-08-25T06:43:47.798889 #23623] ERROR -- : Something happend
 ```
 
+Also we can use it with `ActiveSupport::TaggedLogging`.
+
+```ruby
+l = ActiveSupport::TaggedLogging.new(StructuredLogger.new(STDOUT))
+l.tagged(:crawler) do
+  l.tagged(:downloading) do
+    l.warn("malformed file format", path: downloaded_path.to_s)
+  end
+end
+#=> [crawler] [downloading] malformed file format: path="/opt/app/tmp/1234.bin"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/structured_logger.rb

@@ -6,16 +6,15 @@ class StructuredLogger
   include Logger::Severity
   autoload :VERSION, "structured_logger/version"
 
+  attr_accessor :progname
   attr_accessor :formatter
 
-  def self.severity_name(severity)
-    return Logger::SEV_LABEL[severity] || "ANY"
-  end
-
   def initialize(io)
     @logger = Logger.new(io)
+    @progname = nil
     @formatter = nil
-    @default_formatter = Formatter.new
+    @default_formatter = Logger::Formatter.new
+    @argument_formatter = ArgumentFormatter.new
   end
 
   def_delegators :@logger,
@@ -49,42 +48,42 @@ class StructuredLogger
     if level > severity
       return
     end
-    if block_given?
-      *args = yield
-    end
-    s = (@formatter || @default_formatter).call(severity, Time.now, *args)
+    block_result = block_given? ? yield : nil
+    s_severity = format_severity(severity)
+    time = Time.now
+    message = @argument_formatter.call(severity: s_severity,
+                                       time: time,
+                                       progname: @progname,
+                                       args: args,
+                                       block_result: block_result)
+    s = (@formatter || @default_formatter).call(s_severity, time, @progname,
+                                                message)
     @logger << s
   end
 
-  # Default formatter for StructuredLogger.
-  class Formatter
-    attr_accessor :datetime_format
+  private
 
-    def initialize
-      @datetime_format = nil
-    end
+  def format_severity(severity)
+    return Logger::SEV_LABEL[severity] || "ANY"
+  end
 
-    def call(severity, time, message = nil, **options)
-      severity_name = StructuredLogger.severity_name(severity)
-      return FORMAT % {
-        short_severity_name: severity_name[0, 1],
-        datetime: format_datetime(time),
-        pid: Process.pid,
-        severity_name: severity_name,
-        program_name: "",
-        message: format_message(message, **options),
-      }
+  class ArgumentFormatter
+    def call(severity: _, time: _, progname: _,
+             args: args(), block_result: block_result(),
+             **_) # for ignoring future arguments
+      if block_result
+        # {foo: "bar"} => [{foo: bar}]
+        # ["msg", {foo: "bar"}] => ["msg", {foo: "bar"}]
+        *args_and_block_result = block_result
+      else
+        args_and_block_result = args
+      end
+      return format_body(*args_and_block_result)
     end
 
     private
 
-    FORMAT = "%{short_severity_name}, [%{datetime} #%{pid}] %<severity_name>5s -- %{program_name}: %{message}\n"
-
-    def format_datetime(time)
-      time.strftime(@datetime_format || "%Y-%m-%dT%H:%M:%S.%6N".freeze)
-    end
-
-    def format_message(message = nil, **options)
+    def format_body(message = nil, **options)
       return [message, format_options(options)].compact.join(": ")
     end
 

data/lib/structured_logger/version.rb

@@ -1,3 +1,3 @@
 class StructuredLogger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/structured_logger.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "activesupport"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuya.Nishida.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - yuya@j96.org