process_safe_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85efddfa248dd513471e22b9f6bcd61f10cc831c
+  data.tar.gz: acebb65714e21fd05b62ce88fef2deb907aef1ed
+SHA512:
+  metadata.gz: 68ee62bad0557f9fab0f3667e3349efb27e2eebcd0d95cbc586bccc958f3d2f54968d7c50a65af67efe6d28fb32c4a31c7c8b48a2ab311e1802860d07a526f30
+  data.tar.gz: 3e83568c498d45670e7583f2aa3bcec9913fd09948408e7e4942d55121009199e886edff011c8edfa0abe0e0fe8a44f44a3e4ac866f586b61284e8aa7fbbf40d

data/.gitignore

@@ -0,0 +1,12 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+.ruby-version
+vendor
+doc/*
+tmp/*
+.yardoc

data/.pryrc

@@ -0,0 +1,3 @@
+Pry.commands.alias_command 'c', 'continue'
+Pry.commands.alias_command 's', 'step'
+Pry.commands.alias_command 'n', 'next'

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+#  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1
+
+Initial Release

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gemspec
+gem 'parallel' # to run scripts in examples/, not required for this gem

data/LICENSE

@@ -0,0 +1 @@
+Same with Ruby

data/README.md

@@ -0,0 +1,43 @@
+# Process Safe Logger [![Build Status](https://secure.travis-ci.org/sonots/process_safe_logger.png?branch=master)](http://travis-ci.org/sonots/process_safe_logger) [![Dependency Status](https://gemnasium.com/sonots/process_safe_logger.png)](https://gemnasium.com/sonots/process_safe_logger)
+
+testing ruby: 1.9.2, 1.9.3, 2.0.0;
+
+## About Process Safe Logger
+
+Process Safe Logger supports log rotations in multi-processes *safely*.
+
+## Objective
+
+Ruby's standard Logger class originally have had a problem that it's log rotation function does not work safely in multi process environment. This gem fixes the problem. 
+
+The patch is already pull requested to the [githb.com:ruby/ruby](https://github.com/ruby/ruby/pull/428) and will be released with ruby 2.1.0. 
+
+## Installation
+
+    gem install process_safe_logger
+
+## Usage
+
+```ruby
+require 'process_safe_logger'
+logger = ProcessSafeLogger.new('logfile.log', 3, 1024)
+```
+
+Option parameters are same with Ruby's Logger. See [docs.ruby-lang.org:Logger](http://docs.ruby-lang.org/en/2.0.0/Logger.html).
+
+## Further Reading
+
+1. [sonots:blog : RubyのLoggerはスレッドセーフ(＆プロセスセーフ)かどうか調べてみた](http://blog.livedoor.jp/sonots/archives/32645828.html) (Japanese)
+2. [Inter-process locking for log rotation by sonots · Pull Request #428 · ruby/ruby](https://github.com/ruby/ruby/pull/428)
+
+## 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](../../pull/new/master)
+
+## License
+
+Same with ruby.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib -r process_safe_logger.rb'
+end
+task :c => :console

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/process_safe_logger_in_processes.rb

@@ -0,0 +1,9 @@
+require 'process_safe_logger'
+require 'parallel'
+
+logger = ProcessSafeLogger.new("/tmp/test.log", 3, 1024 * 10)
+Parallel.map(['a', 'b'], :in_processes => 2) do |letter|
+  300000.times do
+    logger.info letter * 5000
+  end
+end

data/examples/process_safe_logger_in_threads.rb

@@ -0,0 +1,9 @@
+require 'process_safe_logger'
+require 'parallel'
+
+logger = ProcessSafeLogger.new("/tmp/test.log", 3, 1024 * 10)
+Parallel.map(['a', 'b'], :in_threads => 2) do |letter|
+  300000.times do
+    logger.info letter * 5000
+  end
+end

data/examples/ruby_logger_in_processes.rb

@@ -0,0 +1,9 @@
+require 'logger'
+require 'parallel'
+
+logger = Logger.new("/tmp/test.log", 3, 1024 * 10)
+Parallel.map(['a', 'b'], :in_processes => 2) do |letter|
+  300000.times do
+    logger.info letter * 5000
+  end
+end

data/examples/ruby_logger_in_threads.rb

@@ -0,0 +1,9 @@
+require 'logger'
+require 'parallel'
+
+logger = Logger.new("/tmp/test.log", 3, 1024 * 10)
+Parallel.map(['a', 'b'], :in_threads => 2) do |letter|
+  300000.times do
+    logger.info letter * 5000
+  end
+end

data/lib/process_safe_logger.rb

@@ -0,0 +1,105 @@
+require 'logger'
+
+if ::Logger::LogDevice.private_method_defined?(:lock_shift_log)
+  class ProcessSafeLogger < ::Logger
+  end
+else
+  class ProcessSafeLogger < ::Logger
+    # Override to use ::ProcessSafeLogger::LogDevice
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      super(nil, shift_age, shift_size)
+      if logdev
+        @logdev = ::ProcessSafeLogger::LogDevice.new(logdev, :shift_age => shift_age,
+                                :shift_size => shift_size)
+      end
+    end
+
+    class LogDevice < ::Logger::LogDevice
+      # Override as my patch
+      def open_logfile(filename)
+        begin
+          open(filename, (File::WRONLY | File::APPEND))
+        rescue Errno::ENOENT
+          create_logfile(filename)
+        end
+      end
+
+      # Override as my patch
+      def create_logfile(filename)
+        begin
+          logdev = open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
+          logdev.flock(File::LOCK_EX)
+          logdev.sync = true
+          add_log_header(logdev)
+          logdev.flock(File::LOCK_UN)
+        rescue Errno::EEXIST
+          # file is created by another process
+          logdev = open_logfile(filename)
+          logdev.sync = true
+        end
+        logdev
+      end
+
+      # Override as my patch
+      def add_log_header(file)
+        file.write(
+          "# Logfile created on %s by %s\n" % [Time.now.to_s, Logger::ProgName]
+        ) if file.size == 0
+      end
+
+      # Override as my patch
+      def check_shift_log
+        if @shift_age.is_a?(Integer)
+          # Note: always returns false if '0'.
+          if @filename && (@shift_age > 0) && (@dev.stat.size > @shift_size)
+            lock_shift_log { shift_log_age }
+          end
+        else
+          now = Time.now
+          period_end = previous_period_end(now)
+          if @dev.stat.mtime <= period_end
+            lock_shift_log { shift_log_period(period_end) }
+          end
+        end
+      end
+
+      # Defien as my patch
+      if /mswin|mingw/ =~ RUBY_PLATFORM
+        def lock_shift_log
+          yield
+        end
+      else
+        def lock_shift_log
+          retry_limit = 8
+          retry_sleep = 0.1
+          begin
+            File.open(@filename, File::WRONLY | File::APPEND) do |lock|
+              lock.flock(File::LOCK_EX) # inter-process locking. will be unlocked at closing file
+              ino = lock.stat.ino
+              if ino == File.stat(@filename).ino
+                yield # log shifting
+              else
+                # log shifted by another process (i-node before locking and i-node after locking are different)
+                @dev.close rescue nil
+                @dev = open_logfile(@filename)
+                @dev.sync = true
+              end
+            end
+          rescue Errno::ENOENT
+            # @filename file would not exist right after #rename and before #create_logfile
+            if retry_limit <= 0
+              warn("log rotation inter-process lock failed. #{$!}")
+            else
+              sleep retry_sleep
+              retry_limit -= 1
+              retry_sleep *= 2
+              retry
+            end
+          end
+        rescue
+          warn("log rotation inter-process lock failed. #{$!}")
+        end
+      end
+    end
+  end
+end

data/process_safe_logger.gemspec

@@ -0,0 +1,25 @@
+#! /usr/bin/env gem build
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name          = 'process_safe_logger'
+  gem.version       = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).chomp
+  gem.authors       = ["Naotoshi Seo"]
+  gem.email         = ["sonots@gmail.com"]
+  gem.homepage      = "https://github.com/sonots/process_safe_logger"
+  gem.summary       = "Process-safe Logger supports log rotations in multi-processes safely"
+  gem.description   = gem.summary
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  # for testing
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.11"
+
+  # for debug
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require "bundler/setup"
+
+require "pry"
+require 'process_safe_logger'
+
+ROOT = File.dirname(__FILE__)
+Dir[File.expand_path("support/**/*.rb", ROOT)].each {|f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: process_safe_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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-nav
+  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: Process-safe Logger supports log rotations in multi-processes safely
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- examples/process_safe_logger_in_processes.rb
+- examples/process_safe_logger_in_threads.rb
+- examples/ruby_logger_in_processes.rb
+- examples/ruby_logger_in_threads.rb
+- lib/process_safe_logger.rb
+- process_safe_logger.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/process_safe_logger
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Process-safe Logger supports log rotations in multi-processes safely
+test_files:
+- spec/spec_helper.rb