log_box 0.0.1a

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTcxODAzNDc2Njc1NzBkZTFlMzE3OTRhM2M3NDRmNWNjNGZmNzAwMg==
+  data.tar.gz: !binary |-
+    NzFmMDQwMTRkYTRjNTVlNTgxZjU3OGFiNzBhNWQ5YTZmNjk0Y2JlYQ==
+SHA512:
+  metadata.gz: !binary |-
+    OWUzMjQ1NDA4MTk5Yzc5NThiZGNkODMwMTdhNGUzOWRhZDMwYmQ3NjAxMjY3
+    NWNmNmM0MGM0M2JkYWE4MThjZWQyMzRiYzRiZTM5NzQyMGVkNzg3Zjg1M2Ew
+    NTljY2JkNGE3YmY2NzRmMGQ2NWEwNzdhMjlmYjdiMWI4NGIzNjQ=
+  data.tar.gz: !binary |-
+    YmQyMDU4MWYwODM0ZGViNmJiMjA4M2JmMDY3ZWFhYzdmZDE3MDQxNWQ4NmYz
+    ZDliYjVlNDQyYjc1YTdmZDMzZDRmZWQzMWM1MGJkZmQxMWRmOGUwZTMwODdl
+    NDI2NTUzYTkyZTlkYTFjZWQ2YzQ0ZTQ4NGE0YTNhMDk3NmYwOGQ=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jun Yoshida
+
+MIT 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,29 @@
+# LogBox
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'log_box'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log_box
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/log_box/version.rb

@@ -0,0 +1,3 @@
+module LogBox
+  VERSION = "0.0.1a"
+end

data/lib/log_box.rb

@@ -0,0 +1,77 @@
+require "log_box/version"
+require "fluent-logger"
+require "pp"
+
+module LogBox
+  DEFAULT_TAG = :thread
+
+  def self.log(obj, options = {})
+    o = { tag: DEFAULT_TAG, time: current_time, log: obj }.merge(options)
+    tag = o.delete :tag
+    init_log_box_tag_if_not tag
+    log_box[tag] << o
+  end
+
+
+  # Following log will be stored into fluentd:
+  # {
+  #     "_id" : ObjectId("52c4a1f4e1eef37b9900001a"),
+  #     "tag" : "delayed_job",
+  #     "logs" : [
+  #         {
+  #             "time" : "2014-01-01 15:16:43 -0800",
+  #             "log" : "Ho-ho",
+  #             "priority" : 3
+  #         }
+  #     ],
+  #     "time" : ISODate("2014-01-01T23:17:01.000Z")
+  # }
+  def self.flush(options = {})
+    o = { tag: DEFAULT_TAG }.merge(options)
+    tag = o[:tag]
+    o[:logs] = log_box[tag]
+    flush_to_fluentd o
+    delete_log_box_tag tag
+  end
+
+  def self.display
+    pp log_box
+  end
+
+  def self.log_box
+    Thread.current[:_log_box]
+  end
+
+  private
+
+  def self.current_time
+    Time.now
+  end
+
+  def self.init_log_box
+    Thread.current[:_log_box] = {}  # key: tag, value: Array of Hash
+  end
+
+  def self.init_log_box_if_not
+    init_log_box if log_box.nil?
+  end
+
+  def self.init_log_box_tag_if_not(tag = :thread)
+    init_log_box_if_not
+    log_box[tag] ||= []
+  end
+
+  def self.delete_log_box_tag(tag = :thread)
+    log_box.delete tag
+  end
+
+  def self.init_log_box_tag(tag = :thread)
+    log_box[tag] = []
+  end
+
+  Logger = Fluent::Logger::FluentLogger.new(nil)
+
+  def self.flush_to_fluentd(result)
+    Logger.post 'log_box', result
+  end
+end

data/log_box.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_box/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log_box"
+  spec.version       = LogBox::VERSION
+  spec.authors       = ["Jun Yoshida"]
+  spec.email         = ["yoshida.jun@gmail.com"]
+  spec.description   = %q{group Rails log by Web transaction or any other grouping}
+  spec.summary       = %q{separate Rails log per Web transaction}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'fluent-logger'
+  spec.add_development_dependency 'rspec'
+end

data/spec/log_box_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'log_box'
+
+RSpec::Matchers.define :include_log do |message|
+  match do |logs|
+    logs ||= []
+    logs.include?({time: current_time_, log: message})
+  end
+end
+
+RSpec::Matchers.define :include_key_value do |key, value|
+  match do |logs|
+    logs ||= []
+    logs.map { |log| log[key] }.include? value
+  end
+end
+
+describe LogBox do
+  let(:current_time_) { '2014-01-23' }
+  let(:default_tag_) { LogBox::DEFAULT_TAG }
+
+  let(:new_tag_) { :new_tag }
+
+  let(:message_1_) { 'hello 1' }
+  let(:message_2_) { 'hello 2' }
+
+  before do
+    LogBox.send(:init_log_box)
+    LogBox.stub(:current_time).and_return(current_time_)
+  end
+
+  def verify(message, tag = default_tag_)
+    expect(LogBox.log_box[tag]).to include_log(message)
+  end
+
+  def verify_not(message, tag = default_tag_)
+    expect(LogBox.log_box[tag]).not_to include_log(message)
+  end
+
+  def log(message, options = {})
+    LogBox.log message, options
+  end
+
+  def try_flush(expected = {})
+    tag = expected.delete(:tag) || default_tag_
+    LogBox.should_receive(:flush_to_fluentd) do |obj_to_fluentd|
+      expect(obj_to_fluentd[:tag]).to eq(tag)
+      expect(obj_to_fluentd).to have_key(:logs)
+      expected.each_pair do |key, value|
+        expect(obj_to_fluentd[:logs]).to include_key_value(key, value)
+      end
+    end
+    LogBox.flush tag: tag
+  end
+
+  context 'one box' do
+    describe '#log' do
+      it 'init_log_box' do
+        log message_1_
+        LogBox.send(:init_log_box)
+        verify_not message_1_
+      end
+
+      it 'default tag' do
+        log message_1_
+        verify message_1_
+        verify_not message_2_
+
+        log message_2_
+        verify message_1_
+        verify message_2_
+      end
+
+      it 'new tag' do
+        log message_1_, tag: new_tag_
+        verify message_1_, new_tag_
+        verify_not message_1_
+      end
+
+      it 'additional key value' do
+        log message_1_, tag: new_tag_, new_key: 'new_value'
+        expect(LogBox.log_box[new_tag_]).to include_key_value(:new_key, 'new_value')
+      end
+    end
+
+    describe '#flush' do
+      it 'default tag' do
+        log message_1_
+        try_flush log: message_1_
+      end
+
+      it '2 logs' do
+        log message_1_
+        log message_2_
+        try_flush log: message_1_, log: message_2_
+      end
+    end
+  end
+
+  context 'multiple boxes' do
+    describe '#log' do
+      it 'default, new_tag' do
+        log message_1_
+        log message_2_, tag: new_tag_
+
+        verify message_1_
+        verify_not message_2_
+
+        verify message_2_, new_tag_
+        verify_not message_1_, new_tag_
+      end
+    end
+
+    describe '#flush' do
+      it 'default, new_tag' do
+        log message_1_
+        log message_2_, tag: new_tag_
+
+        try_flush tag: default_tag_, log: message_1_
+        try_flush tag: new_tag_, log: message_2_
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rubygems'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: log_box
+version: !ruby/object:Gem::Version
+  version: 0.0.1a
+platform: ruby
+authors:
+- Jun Yoshida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: group Rails log by Web transaction or any other grouping
+email:
+- yoshida.jun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/log_box.rb
+- lib/log_box/version.rb
+- log_box.gemspec
+- spec/log_box_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: separate Rails log per Web transaction
+test_files:
+- spec/log_box_spec.rb
+- spec/spec_helper.rb
+has_rdoc: