chrono_logger 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08bc980d1aec36c6dd84be8aa0964a89f026357a
-  data.tar.gz: 36c8767249f645a1cf6a491dd03a29e0e47a95bd
+  metadata.gz: 9e088e9bf45178e23ef873d64e92e168bc026f41
+  data.tar.gz: 8fcc295b88f5edac15e16f1af825aa2b9d9e64db
 SHA512:
-  metadata.gz: 364f9de5b3a3694e4e54d4dfa2a27511c6a0d18bbcb5186f69bf538503cd950fdd46ef35681f950ec8b158977103b3fa2f4496851f1b3939e75846d0a5a40ba9
-  data.tar.gz: db43d8701920d88b5fa46e1b9ed3aeae4b6fa97f5b82aace8fc99431c0f64decb645a4a2953029d16ec146bab507c358423971c73acca6d2c232bc6407eb2495
+  metadata.gz: d3af87c076d10eae81b2a574204c516280fc1b35020c3123a0e9846c2d9e88c928fa8f460c9d872a2f2684aedd339a5c5f81de3a9ef85b68439dea32f6c816e7
+  data.tar.gz: ad7dcd2fd514cc53ef23947477ed67a020112e130326d893642fdfdbd65e41df6e9b8ac0c96f030534fcebb08f82f5a53faae804519e446d24b3fdcf9ce58902

data/README.md

@@ -33,8 +33,8 @@ File.exist?('/log/production.log.20150127')
 Current my projects uses `::Logger` with cronolog. So
 
 - Reduce dependency such as cronolog
-- Remove mutexes in ruby world because os already does
-- Support time based rotation without renaming file because file renaming is complex
+- Remove mutexes in ruby world because os already does when some environments (ex: ext4 file system)
+- Support time based rotation without renaming file because file renaming sometime makes problem
 
 ## Installation
 
@@ -56,7 +56,7 @@ Or install it yourself as:
 
 Same interfaces ruby's stdlib `Logger` except for `new` method.
 
-```
+```ruby
 require 'chrono_logger'
 
 # specify path with `Time#strftime` format
@@ -68,9 +68,29 @@ logger.info("Enjoy")
 logger.debug("programming!")
 ```
 
+With Rails:
+
+```ruby
+# in config/environments/{development,production}.rb
+
+config.logger = ChronoLogger.new("#{config.paths['log'].first}.%Y%m%d")
+```
+
+## Migrating from `::Logger` with cronolog
+
+You only change `Logger.new` into `ChronoLogger.new`:
+
+```ruby
+# for instance your setup is like the following
+Logger.new(IO.popen("/usr/sbin/cronolog production.%Y%m%d", "w"))
+
+# turns into
+ChronoLogger.new('production.%Y%m%d')
+```
+
 ## Limitation
 
-- High performance only daily based time formatting path for example `'%Y%m%d'`. You can create pull request if you need other time period.
+- High performance logging only daily based time formatting path for example `'%Y%m%d'`. You can create pull request if you need other time period.
 
 ## Contributing
 
@@ -83,3 +103,8 @@ logger.debug("programming!")
 ## License
 
 MIT. See [LICENSE.txt](LICENSE.txt) for more details.
+
+## Resources
+
+- [ChronoLogger logging is 1.5x faster than ruby's stdlib Logger](https://coderwall.com/p/vjjszq/chronologger-logging-is-1-5x-faster-than-ruby-s-stdlib-logger)
+

data/lib/chrono_logger.rb

@@ -69,7 +69,7 @@ class ChronoLogger < Logger
     end
 
     def write(message)
-      check_shift_log if @pattern
+      check_and_shift_log if @pattern
       @dev.write(message)
     rescue
       warn("log writing failed. #{$!}")
@@ -101,12 +101,12 @@ class ChronoLogger < Logger
       logdev
     end
 
-    def check_shift_log
+    def check_and_shift_log
       if next_period?(Time.now)
         now = Time.now
         new_filename = now.strftime(@pattern)
         next_start_period = next_start_period(now, @period)
-        shift_log_period(new_filename)
+        shift_log(new_filename)
         @filename = new_filename
         @next_start_period = next_start_period
       end
@@ -120,7 +120,7 @@ class ChronoLogger < Logger
       end
     end
 
-    def shift_log_period(filename)
+    def shift_log(filename)
       begin
         @mutex.synchronize do
           tmp_dev = @dev

data/lib/chrono_logger/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class ChronoLogger < Logger
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chrono_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Takayuki Matsubara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler