huyegger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f83dbddff8fc332ddd87b9dfb1dc8dc436a0b61c
+  data.tar.gz: 11554a6172141aa15623732ac5a722017e3e88f5
+SHA512:
+  metadata.gz: 155c12e0fb9107742dcfd2c927ead64e0ce6fc5fc4c3a5525980b2b7cb155080815af3a01ce33aa7fd6630d79ca35ac0a7452fedb450fc26037649315732c97d
+  data.tar.gz: 4e346d2e858d273501523a10eb406404e13d3ebb1a82c48585399540425b19e7eff1d157f3d0d49532a94488116d9407afaf03cef4d10878912a2743968e2a8c

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nikolay Markov
+
+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,54 @@
+# Huyegger
+
+This is JSON Logger (Huyegger) for ruby.
+
+## Installation
+
+```ruby
+gem install hyegger
+
+gem "huyegger"
+```
+
+## Usage
+
+```ruby
+# require "json" # to use default json encoder (see below)
+
+file_logger = Logger.new("/var/log/your_progname.log")
+logger = Huyegger::Logger.new(file_logger)
+
+# or better
+# require "syslog/logger"
+syslog_logger = Syslog::Logger.new("your_progname")
+logger = Huyegger::Logger.new(syslog_logger)
+
+# Write messages:
+logger.info "log message"
+# => { "level": "INFO", "message": "test" }
+logger.info { "http.host" => '127.0.0.1', message: "log message" }
+# => { "level": "INFO", "message": "test", "http.host": "127.0.0.1" }
+
+# Store context for all log messages, it will be merged to resulting messages
+logger.context("http.host" => '127.0.0.1')
+logger.info('test')
+# => { "level": "INFO", "message": "test", "http.host": "127.0.0.1" }
+
+# Remove context
+logger.purge_context!
+
+# Configure json encoder
+Huyegger.json_encoder = proc { |obj, *opts| Oj.dump(obj, *opts) }
+
+# Default implementation of json_encoder uses `Object#to_json`,
+# but you need to `require "json"` to use default json encoder.
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mainameiz/huyegger.
+
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "huyegger"
+
+# 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(__FILE__)

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/huyegger.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'huyegger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "huyegger"
+  spec.version       = Huyegger::VERSION
+  spec.authors       = ["Nikolay Markov"]
+  spec.email         = ["mainameiz@gmail.com"]
+
+  spec.summary       = %q{JSON Logger for ruby}
+  spec.homepage      = "http://github.com/mainameiz/huyegger"
+  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'] = "https://rubygems.org"
+  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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.10"
+end

data/lib/huyegger.rb

@@ -0,0 +1,12 @@
+require "huyegger/version"
+require "huyegger/logger"
+
+module Huyegger
+  DEFAULT_JSON_ENCODER = proc { |obj, *opts| obj.to_json(*opts) }
+
+  class << self
+    attr_accessor :json_encoder
+  end
+
+  self.json_encoder = DEFAULT_JSON_ENCODER
+end

data/lib/huyegger/formatter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+require "logger"
+
+module Huyegger
+  class Formatter
+    SEVERITY_STR = {
+      ::Logger::DEBUG => 'DEBUG',
+      ::Logger::INFO => 'INFO',
+      ::Logger::WARN => 'WARN',
+      ::Logger::ERROR => 'ERROR',
+      ::Logger::FATAL => 'FATAL',
+      ::Logger::UNKNOWN => 'UNKNOWN'
+    }
+
+    attr_reader :original_formatter
+
+    def initialize(original_formatter)
+      @original_formatter = original_formatter
+    end
+
+    def purge_context!
+      __context__.clear
+    end
+
+    def context(context)
+      __context__.merge!(context) unless context.nil?
+    end
+
+    # This method is invoked when a log event occurs
+    def call(severity, timestamp, progname, msg)
+      msg = original_formatter.call(severity, timestamp, progname, msg) if original_formatter
+      json_message = {}
+
+      add_severity!(json_message, severity)
+      json_message.merge!(__context__)
+      add_message!(json_message, msg)
+
+      Huyegger.json_encoder.call(json_message)
+    end
+
+    private
+
+    def add_severity!(json_message, severity)
+      case severity
+      when String
+        json_message.merge!('level' => severity)
+      when Integer
+        json_message.merge!('level' => SEVERITY_STR.fetch(severity))
+      else
+        json_message.merge!('level' => SEVERITY_STR.fetch(::Logger::UNKNOWN))
+      end
+    end
+
+    def add_message!(json_message, msg)
+      case msg
+      when String
+        json_message.merge!('message' => msg)
+      when Hash
+        json_message.merge!('message' => 'Empty message') # default message because it is required
+        json_message.merge!(msg)
+      else
+        json_message.merge!('message' => msg.inspect)
+      end
+    end
+
+    def __context__
+      # Use object_id to avoid conflicts with other instances
+      Thread.current[:"__huyegger_context__#{object_id}"] ||= {}
+    end
+  end
+end

data/lib/huyegger/logger.rb

@@ -0,0 +1,18 @@
+require "huyegger/formatter"
+
+module Huyegger
+  module Logger
+    def context(*args)
+      formatter.context(*args)
+    end
+
+    def purge_context!
+      formatter.clear_context!
+    end
+
+    def self.new(logger)
+      logger.formatter = Huyegger::Formatter.new(logger.formatter)
+      logger.extend(self)
+    end
+  end
+end

data/lib/huyegger/version.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: huyegger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikolay Markov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+description: 
+email:
+- mainameiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- huyegger.gemspec
+- lib/huyegger.rb
+- lib/huyegger/formatter.rb
+- lib/huyegger/logger.rb
+- lib/huyegger/version.rb
+homepage: http://github.com/mainameiz/huyegger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: JSON Logger for ruby
+test_files: []