log_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3eb86ba92366fe1b7bd2ce2e1ee8710f5291f6ac
+  data.tar.gz: aa7049e97734f880b43cf7602af22f745300faeb
+SHA512:
+  metadata.gz: a3f61442413c1996da8b32952d04647e9de7a892810d579728196dce62e804288a1f63bae32d400fdf25d07be4d13d700b075c966ca2f139c0ae8b516eebbeeb
+  data.tar.gz: 6340c09cd30f77bc15e0730858d9fea09d7b7751b9088d04ee8652536d8caa21d8cd4822591932a46a9dae4990ed1a09e6eee235437ed71e3951a06379aa6c29

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at chad_lwm@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 chad_lwm
+
+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,139 @@
+# LogFormatter
+
+Log Formatter for Ruby and other logger.
+
+Details as following:
+
+- `log_formatter/ruby_json_formatter'` : ruby logger json formatter
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log_formatter
+
+## Usage
+
+## Ruby Logger Json Formatter
+
+### quick start
+
+```
+require 'logger_formatter.rb'
+require 'log_formatter/ruby_json_formatter'
+
+logger.formatter = RubyJSONFormatter::Base.new
+
+logger.info 'test data'
+```
+
+result:
+
+```
+{
+  "message": "test data",
+  "log_level": "INFO",
+  "log_type": null,
+  "log_app": null,
+  "log_timestamp": "2016-08-25T15:34:25+08:00"
+}
+```
+
+### set app and common ext info
+
+```
+logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+logger.info 'test data'
+```
+
+result:
+
+```
+{
+  "source": "examples",
+  "message": "test data",
+  "log_level": "INFO",
+  "log_type": null,
+  "log_app": "app",
+  "log_timestamp": "2016-08-25T15:34:25+08:00"
+}
+```
+
+### log with hash
+
+```
+logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+
+logger.debug({data: "test data", author: 'chad'})
+```
+
+result:
+
+```
+{
+  "source": "examples",
+  "data": "test data",
+  "author": "chad",
+  "log_level": "DEBUG",
+  "log_type": null,
+  "log_app": "app",
+  "log_timestamp": "2016-08-25T15:34:25+08:00"
+}
+```
+
+### reset the defaut key
+
+json formatter will add `log_type`,`log_level`,`log_timestamp`，`log_app` as default key, but you can change them if needed.
+
+```
+logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+  config[:level] = :cus_level
+  config[:type] = :cus_type
+  config[:app] = :cus_app
+  config[:timestamp] = :cus_timestamp
+end
+
+logger.debug({data: "test data", age: 18})
+```
+
+result:
+
+```
+{
+  "source": "examples",
+  "data": "test data",
+  age: 18,
+  "cus_level": "DEBUG",
+  "cus_type": null,
+  "cus_app": "app",
+  "cus_timestamp": "2016-08-25T15:34:25+08:00"
+}
+```
+
+full code to see [examples/ruby_logger](https://github.com/chadlwm/log_formatter/blob/master/examples/ruby_logger.rb)
+
+## Test with Rspec
+
+```
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at `https://github.com/chadlwm/log_formatter`. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "log_formatter"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/ruby_logger.rb

@@ -0,0 +1,51 @@
+require 'logger'
+require 'log_formatter'
+require 'log_formatter/ruby_json_formatter'
+
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+
+# plain initialize
+logger.formatter =  RubyJSONFormatter::Base.new
+
+logger.debug("Created logger")
+logger.info("Program started")
+logger.warn("Nothing to do!")
+# {"message":"Created logger","log_level":"DEBUG","log_type":null,"log_app":null,"log_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"message":"Program started","log_level":"INFO","log_type":null,"log_app":null,"log_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"message":"Nothing to do!","log_level":"WARN","log_type":null,"log_app":null,"log_timestamp":"2016-08-25T15:34:25+08:00"}
+
+# initialize with app and ext info
+logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+
+logger.debug("Created logger")
+logger.info("Program started")
+logger.warn("Nothing to do!")
+# {"source":"examples","message":"Created logger","log_level":"DEBUG","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"source":"examples","message":"Program started","log_level":"INFO","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"source":"examples","message":"Nothing to do!","log_level":"WARN","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
+
+# log hash
+logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+
+logger.debug({data: "Created logger"})
+logger.info({data: "Program started"})
+logger.warn({data: "Nothing to do!"})
+# {"source":"examples","data":"Created logger","log_level":"DEBUG","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"source":"examples","data":"Program started","log_level":"INFO","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"source":"examples","data":"Nothing to do!","log_level":"WARN","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
+
+# log with custome key instead of default keys
+logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+  config[:level] = :cus_level
+  config[:type] = :cus_type
+  config[:app] = :cus_app
+  config[:timestamp] = :cus_timestamp
+end
+
+logger.debug({data: "Created logger"})
+logger.info({data: "Program started"})
+logger.warn({data: "Nothing to do!"})
+# {"source":"examples","data":"Created logger","cus_level":"DEBUG","cus_type":null,"cus_app":"app","cus_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"source":"examples","data":"Program started","cus_level":"INFO","cus_type":null,"cus_app":"app","cus_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"source":"examples","data":"Nothing to do!","cus_level":"WARN","cus_type":null,"cus_app":"app","cus_timestamp":"2016-08-25T15:34:25+08:00"}

data/lib/log_formatter.rb

@@ -0,0 +1,6 @@
+require "log_formatter/version"
+$LOAD_PATH.unshift File.expand_path('.', __FILE__)
+
+module LogFormatter
+  # Your code goes here...
+end

data/lib/log_formatter/ruby_json_formatter.rb

@@ -0,0 +1,63 @@
+require 'logger'
+require 'json'
+require 'time'
+
+module RubyJSONFormatter
+  class Base < ::Logger::Formatter
+    def initialize(app = nil, ext = {})
+      @app = app
+      @ext = ext.is_a?(Hash) ? ext : {}
+      @config = {
+        level: :log_level,
+        type: :log_type,
+        app: :log_app,
+        timestamp: :log_timestamp
+      }
+
+      yield @config if block_given?
+    end
+
+    def call(severity, time, progname, message)
+      @event = build_event(message, severity, time, progname)
+    end
+
+    protected
+
+    def build_event(message, severity, time, progname)
+      data = message
+      if data.is_a?(String) && data.start_with?('{'.freeze)
+        data = (JSON.parse(message) rescue nil) || message
+      end
+
+      event = case data
+                when Hash
+                  data
+                else
+                  {"message".freeze => msg2str(data)}
+              end
+
+      event[@config[:level].freeze] ||= severity
+      event[@config[:type].freeze] = progname
+      event[@config[:app].freeze] = @app
+      event[@config[:timestamp].freeze] = current_time(time).iso8601
+      "#{@ext.merge(event).to_json}\n"
+    end
+
+    def msg2str(msg)
+      case msg
+      when ::String
+        msg.gsub("\n", "\t")
+      when ::Exception
+        "#{ msg.message } (#{ msg.class })\t" <<
+          (msg.backtrace || []).join("\t")
+      else
+        msg.inspect
+      end
+    end
+
+    def current_time(time)
+      return time if time
+      Time.respond_to?(:current) ? Time.current : Time.now
+    end
+  end
+end

data/lib/log_formatter/version.rb

@@ -0,0 +1,3 @@
+module LogFormatter
+  VERSION = "0.1.0"
+end

data/log_formatter.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log_formatter"
+  spec.version       = LogFormatter::VERSION
+  spec.authors       = ["chad_lwm"]
+  spec.email         = ["chad_lwm@hotmail.com"]
+
+  spec.summary       = %q{log formatter}
+  spec.description   = %q{log formatter for json. For Plain Ruby Logger, and for log4r and so on, details to read the REAME.md file.}
+  spec.homepage      = "https://github.com/chadlwm/log_formatter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: log_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chad_lwm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: log formatter for json. For Plain Ruby Logger, and for log4r and so on,
+  details to read the REAME.md file.
+email:
+- chad_lwm@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/ruby_logger.rb
+- lib/log_formatter.rb
+- lib/log_formatter/ruby_json_formatter.rb
+- lib/log_formatter/version.rb
+- log_formatter.gemspec
+homepage: https://github.com/chadlwm/log_formatter
+licenses:
+- MIT
+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: log formatter
+test_files: []