structured_logger 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8997f897e7f961858b3b93d3da6a305767fe834b
+  data.tar.gz: 1131e5ddeaafa27f19e201a90d0a785f80a27211
+SHA512:
+  metadata.gz: 921f12ce660981d634c9105fb874e4c43023d649d5af5459d637962a0f8031def8ba60444a96b58f961ed60d16c5307cfdc6c9af75dfa1563416bf022eaac8f5
+  data.tar.gz: 16194cec17bec2106b3569088a3b5c25dfafa6f119503cb475f7f1b2c2a2984771e18b7a7a3cb1ab0ba620261002e4b900251ca03ddc68fc22a951d36b0a1288

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.2
+  - 2.1
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in structured_logger.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,21 @@
+guard(:bundler) do
+  watch(/\.gemspec\z/)
+  watch("Gemfile")
+end
+
+guard(:test, all_after_pass: true, test_paths: %w(test)) do
+  %w(
+    Gemfile.lock
+    test/test_helper.rb
+  ).each do |path|
+    watch(path) {
+      "test"
+    }
+  end
+
+  watch(%r{\Atest/(.*)\.rb\z})
+
+  watch(%r{\Alib/(.*)\.rb\z}) { |m|
+    "test/#{m[1]}_test.rb"
+  }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yuya.Nishida.
+
+X11 License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# StructuredLogger
+
+A structured logger with Ruby's Logger interface.
+
+[![License X11](https://img.shields.io/badge/license-X11-brightgreen.svg)](https://raw.githubusercontent.com/nishidayuya/structured_logger/master/LICENSE.txt)
+[![Dependency Status](https://gemnasium.com/nishidayuya/structured_logger.svg)](https://gemnasium.com/nishidayuya/structured_logger)
+[![Build Status](https://travis-ci.org/nishidayuya/structured_logger.svg?branch=master)](https://travis-ci.org/nishidayuya/structured_logger)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structured_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structured_logger
+
+## Usage
+
+We can write log with parameters.
+
+```ruby
+t = Time.now; sleep(0.1)
+l = StructuredLogger.new(STDOUT)
+
+l.debug("processed request", started_at: t, elapsed_sec: Time.now - t, status: "ok")
+#=> D, [2015-08-21T05:14:37.022621 #8310] DEBUG -- : processed request: started_at=2015-08-21 05:14:36 +0900 elapsed_sec=0.100156444 status="ok"
+
+l.debug { ["processed request", started_at: t, elapsed_sec: Time.now - t, status: "ok"] }
+#=> D, [2015-08-21T05:15:00.214480 #8416] DEBUG -- : processed request: started_at=2015-08-21 05:15:00 +0900 elapsed_sec=0.100193648 status="ok"
+```
+
+`StructuredLogger` instance methods have Ruby's `Logger` interface. So, we can replace Ruby's `Logger` to `StructuredLogger`.
+
+```ruby
+l = Logger.new(STDOUT)
+l.error("Something happend")
+#=> E, [2015-08-25T06:43:18.244950 #23623] ERROR -- : Something happend
+
+l = StructuredLogger.new(STDOUT)
+l.error("Something happend")
+#=> E, [2015-08-25T06:43:47.798889 #23623] ERROR -- : Something happend
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nishidayuya/structured_logger.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = Dir["test/**/*_test.rb"]
+end
+
+task(default: %i(test build))

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "structured_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/structured_logger.rb

@@ -0,0 +1,100 @@
+require "logger"
+require "forwardable"
+
+class StructuredLogger
+  extend Forwardable
+  include Logger::Severity
+
+  VERSION = "0.0.0"
+
+  attr_accessor :formatter
+
+  def self.severity_name(severity)
+    return Logger::SEV_LABEL[severity] || "ANY"
+  end
+
+  def initialize(io)
+    @logger = Logger.new(io)
+    @formatter = Formatter.new
+  end
+
+  def_delegators :@logger,
+    :close,
+    :level, :level=,
+    :debug?, :info?, :warn?, :error?, :fatal?
+
+  def_delegators :@formatter, :datetime_format, :datetime_format=
+
+  def debug(*args, &block)
+    add(DEBUG, *args, &block)
+  end
+
+  def info(*args, &block)
+    add(INFO, *args, &block)
+  end
+
+  def warn(*args, &block)
+    add(WARN, *args, &block)
+  end
+
+  def error(*args, &block)
+    add(ERROR, *args, &block)
+  end
+
+  def fatal(*args, &block)
+    add(FATAL, *args, &block)
+  end
+
+  def add(severity, *args, &block)
+    if level > severity
+      return
+    end
+    if block_given?
+      *args = yield
+    end
+    s = @formatter.call(severity, Time.now, *args)
+    @logger << s
+  end
+
+  # Default formatter for StructuredLogger.
+  class Formatter
+    attr_accessor :datetime_format
+
+    def initialize
+      @datetime_format = nil
+    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),
+      }
+    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)
+      return [message, format_options(options)].compact.join(": ")
+    end
+
+    def format_options(options)
+      if options.empty?
+        return nil
+      end
+      return options.map { |key, value|
+        "#{key}=#{value.inspect}"
+      }.join(" ")
+    end
+  end
+end

data/structured_logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "structured_logger"
+
+Gem::Specification.new do |spec|
+  spec.name          = "structured_logger"
+  spec.version       = StructuredLogger::VERSION
+  spec.authors       = ["Yuya.Nishida."]
+  spec.email         = ["yuya@j96.org"]
+  spec.summary       = "A structured logger with Ruby's Logger interface."
+  spec.homepage      = "https://github.com/nishidayuya/structured_logger"
+  spec.license       = "X11"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-test"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: structured_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Yuya.Nishida.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/structured_logger.rb
+- structured_logger.gemspec
+homepage: https://github.com/nishidayuya/structured_logger
+licenses:
+- X11
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A structured logger with Ruby's Logger interface.
+test_files: []