fluent-logger 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 534a2ccb4ce18b0c8082c309d464d6291ede39f5
-  data.tar.gz: d57458f299eccdff242de08e5d6ea03d2cee4ed3
+  metadata.gz: eb07188f881f645087ed46e08dcb033abd3e78f3
+  data.tar.gz: c5e7715e87ebf4bb7ca5f5a0afb6297d4772011b
 SHA512:
-  metadata.gz: e5f6dc505d218591c81b5945f894aef62551610a404f8ce6e68b88f5bed88165b9a931a22cd99e3f02180575b0d6d367d617dcd287d544914eecbcf03b349b3f
-  data.tar.gz: 3e4f91caab8f1d472709611867dbe6e3ade664d0fe954123f08e193a18922e359bb7ca3665f04d552ba7432db2802dd1dd322d7cfcc3bcbda49c83724d19109a
+  metadata.gz: 44b031f5063e83cac44e704f8a3fe95d1fa8bdf732f68dad096bd6da73b41c31c480412c00c1fe006f9b2bd6285e626f6ab6bc3096115ac559c3961ffd3c9a59
+  data.tar.gz: d3929bbf74cc3e77fc76149f98a0cd001f34213a715c807290cdc7bdc88df35d4d11d07d963a6a765ad144552ee99fb8cb191d7dce8f28e91e4e4c5c053ef37c

data/.travis.yml

@@ -1,10 +1,10 @@
 rvm:
- - 1.9.3
- - 2.0.0
  - 2.1
  - 2.2
- - 2.3.1
- - 2.4.0
+ - 2.3.7
+ - 2.4.5
+ - 2.5.3
+ - 2.6.0
  - ruby-head
 
 gemfile:
@@ -20,15 +20,15 @@ matrix:
   allow_failures:
     - rvm: ruby-head
   exclude:
-    - rvm: 1.9.3
-      gemfile: Gemfile
-    - rvm: 2.0.0
-      gemfile: Gemfile
     - rvm: 2.2
       gemfile: Gemfile.v0.12
-    - rvm: 2.3.1
+    - rvm: 2.3.7
       gemfile: Gemfile.v0.12
-    - rvm: 2.4.0
+    - rvm: 2.4.5
+      gemfile: Gemfile.v0.12
+    - rvm: 2.5.3
+      gemfile: Gemfile.v0.12
+    - rvm: 2.6.0
       gemfile: Gemfile.v0.12
     - rvm: ruby-head
       gemfile: Gemfile.v0.12

data/ChangeLog

@@ -1,3 +1,7 @@
+Release 0.8.0 - 2019/01/25
+
+  * Add use_nonblock and wait_writeable parameters
+
 Release 0.7.2 - 2018/01/04
 
   * Fix EventTime for nanosecond_precision

data/README.md

@@ -11,6 +11,7 @@ A structured event logger
 ```ruby
 require 'fluent-logger'
 
+# API: FluentLogger.new(tag_prefix, options)
 log = Fluent::Logger::FluentLogger.new(nil, :host => 'localhost', :port => 24224)
 unless log.post("myapp.access", {"agent" => "foo"})
   p log.last_error # You can get last error object via last_error method
@@ -32,26 +33,71 @@ end
 # output: myapp.access {"agent":"foo"}
 ```
 
-### Singleton
+### Tag prefix
 ```ruby
 require 'fluent-logger'
 
-Fluent::Logger::FluentLogger.open(nil, :host => 'localhost', :port => 24224)
-Fluent::Logger.post("myapp.access", {"agent" => "foo"})
+log = Fluent::Logger::FluentLogger.new('myapp', :host => 'localhost', :port => 24224)
+log.post("access", {"agent" => "foo"})
 
 # output: myapp.access {"agent":"foo"}
 ```
 
-### Tag prefix
+### Nonblocking write
+
 ```ruby
 require 'fluent-logger'
 
-log = Fluent::Logger::FluentLogger.new('myapp', :host => 'localhost', :port => 24224)
-log.post("access", {"agent" => "foo"})
+log = Fluent::Logger::FluentLogger.new(nil, :host => 'localhost', :port => 24224, :use_nonblock => true, :wait_writeable => false)
+begin
+  log.post("myapp.access", {"agent" => "foo"})
+rescue IO::EAGAINWaitWritable => e
+  # wait code for avoding "Resource temporarily unavailable"
+end
+
+# output: myapp.access {"agent":"foo"}
+```
+
+### Singleton
+```ruby
+require 'fluent-logger'
+
+Fluent::Logger::FluentLogger.open(nil, :host => 'localhost', :port => 24224)
+Fluent::Logger.post("myapp.access", {"agent" => "foo"})
 
 # output: myapp.access {"agent":"foo"}
 ```
 
+### Logger options
+
+#### host (String)
+
+fluentd instance host
+
+#### port (Integer)
+
+fluentd instance port
+
+#### socket_path (String)
+
+If specified, fluentd uses unix domain socket instead of TCP.
+
+#### nanosecond_precision (Bool)
+
+Use nano second event time instead of epoch. See also "Tips" section.
+
+#### use_nonblock (Bool)
+
+Use nonblocking write(`IO#write_nonblock`) instead of normal write(`IO#write`). If `Logger#post` stuck on your environment, specify `true`.
+
+#### wait_writeable (Bool)
+
+If `true`, `Logger#post` raises an error when nonblocking write gets `EAGAIN`.
+
+#### buffer_overflow_handler (Proc)
+
+Pass callback for handling buffer overflow with pending data. See "Buffer overflow" section.
+
 ### Standard ::Logger compatible interface
 
 #### Example1

data/fluent-logger.gemspec

@@ -1,18 +1,10 @@
 # encoding: utf-8
 $:.push File.expand_path('../lib', __FILE__)
+require 'fluent/logger/version'
 
 Gem::Specification.new do |gem|
   version_file = "lib/fluent/logger/version.rb"
-  version = File.read("VERSION").strip
-  File.open(version_file, "w") {|f|
-    f.write <<EOF
-module Fluent
-  module Logger
-    VERSION = '#{version}'
-  end
-end
-EOF
-  }
+  version = Fluent::Logger::VERSION
 
   gem.name        = %q{fluent-logger}
   gem.version     = version
@@ -27,6 +19,7 @@ EOF
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ['lib']
+  gem.license       = "Apache-2.0"
 
   gem.add_dependency "msgpack", ">= 1.0.0", "< 2"
   gem.add_development_dependency 'rake', '>= 0.9.2'

data/lib/fluent/logger/fluent_logger.rb

@@ -64,7 +64,8 @@ module Fluent
 
         options = {
           :host => 'localhost',
-          :port => 24224
+          :port => 24224,
+          :use_nonblock => false
         }
 
         case args.first
@@ -81,6 +82,7 @@ module Fluent
         @port = options[:port]
         @socket_path = options[:socket_path]
         @nanosecond_precision = options[:nanosecond_precision]
+        @use_nonblock = options[:use_nonblock]
 
         @factory = MessagePack::Factory.new
         if @nanosecond_precision
@@ -96,8 +98,8 @@ module Fluent
         @log_reconnect_error_threshold = options[:log_reconnect_error_threshold] || RECONNECT_WAIT_MAX_COUNT
 
         @buffer_overflow_handler = options[:buffer_overflow_handler]
-        if logger = options[:logger]
-          @logger = logger
+        if options[:logger]
+          @logger = options[:logger]
         else
           @logger = ::Logger.new(STDERR)
           if options[:debug]
@@ -107,6 +109,9 @@ module Fluent
           end
         end
 
+        @wait_writeable = true
+        @wait_writeable = options[:wait_writeable] if options.key?(:wait_writeable)
+
         @last_error = {}
 
         begin
@@ -229,6 +234,9 @@ module Fluent
             @pending = nil
             true
           rescue => e
+            unless wait_writeable?(e)
+              raise e
+            end
             set_last_error(e)
             if pending_bytesize > @limit
               @logger.error("FluentLogger: Can't send logs to #{connection_string}: #{$!}")
@@ -246,7 +254,11 @@ module Fluent
         unless connect?
           connect!
         end
-        @con.write data
+        if @use_nonblock
+          @con.write_nonblock data
+        else
+          @con.write data
+        end
         #while true
         #  puts "sending #{data.length} bytes"
         #  if data.length > 32*1024
@@ -298,6 +310,14 @@ module Fluent
         # TODO: Check non GVL env
         @last_error[Thread.current.object_id] = e
       end
+
+      def wait_writeable?(e)
+        if e.instance_of?(IO::EAGAINWaitWritable)
+          @wait_writeable
+        else
+          true
+        end
+      end
     end
   end
 end

data/lib/fluent/logger/version.rb

@@ -1,5 +1,5 @@
 module Fluent
   module Logger
-    VERSION = '0.7.2'
+    VERSION = '0.8.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-logger
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -117,7 +117,6 @@ files:
 - Gemfile.v0.12
 - README.md
 - Rakefile
-- VERSION
 - bin/fluent-post
 - fluent-logger.gemspec
 - lib/fluent-logger.rb
@@ -144,7 +143,8 @@ files:
 - spec/support/timecop.rb
 - spec/test_logger_spec.rb
 homepage: https://github.com/fluent/fluent-logger-ruby
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: fluent logger for ruby

data/VERSION

@@ -1 +0,0 @@
-0.7.2