timber 2.0.19 → 2.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e4d4e220779ebe8ea442c98c2f03f36cf12f438
-  data.tar.gz: e995c553745a8839d306eea480d359063a779b9c
+  metadata.gz: 946dc64576210d225bbf4952fa78363705b3b87f
+  data.tar.gz: e972b58acf8efc60ebcc79746939d7bbceeadd06
 SHA512:
-  metadata.gz: ca96f8e714fef59f4a14155b0376094928171636f2ca4cbb372ef928112d5e4c9c1f4be40c2cb856f94568d4139066e95d4544380fa043540c831a138f06a5d0
-  data.tar.gz: 41e76ccddb69c9961330560d78c9d82d941e2af0ad91e6e506ae99628147ea3ff96f43c9979299fdaa84b3638adaf88512e1e1532f11c7b33aae8a5287853031
+  metadata.gz: f44fdf7da119df5a80cd1cb589f1c55d8fee39bfccd6cacf35eaf9b5944afdc227cb6d715473c651d3830035915bc62df11cae4c7c58a779331870fa23659d26
+  data.tar.gz: 7cad85ce7ea3c9df75fd2d3fc7e18df07d42d20f294bba6af8803dce710f7b9a7e0a8990ef243d3feff942807625ffb8b40bc2ecde89c98e2604a7e129c94533

data/lib/timber/log_devices/http.rb

@@ -1,3 +1,6 @@
+require "base64"
+require "net/https"
+
 module Timber
   module LogDevices
     # A highly efficient log device that buffers and delivers log messages over HTTPS to
@@ -80,6 +83,10 @@ module Timber
       #   each HTTP payload. If the queue exceeds this limit an HTTP request will be issued. Bigger
       #   payloads mean higher throughput, but also use more memory. Timber will not accept
       #   payloads larger than 1mb.
+      # @option attributes [Symbol] :flush_continuously (true) This should only be disabled under
+      #   special circumstsances (like test suites). Setting this to `false` disables the
+      #   continuous flushing of log message. As a result, flushing must be handled externally
+      #   via the #flush method.
       # @option attributes [Symbol] :flush_interval (1) How often the client should
       #   attempt to deliver logs to the Timber API in fractional seconds. The HTTP client buffers
       #   logs and this options represents how often that will happen, assuming `:batch_byte_size`
@@ -106,22 +113,25 @@ module Timber
         @api_key = api_key || raise(ArgumentError.new("The api_key parameter cannot be blank"))
         @timber_url = URI.parse(options[:timber_url] || ENV['TIMBER_URL'] || TIMBER_URL)
         @batch_size = options[:batch_size] || 1_000
+        @flush_continuously = options[:flush_continuously] != false
         @flush_interval = options[:flush_interval] || 1 # 1 second
         @requests_per_conn = options[:requests_per_conn] || 2_500
         @msg_queue = LogMsgQueue.new(@batch_size)
         @request_queue = options[:request_queue] || SizedQueue.new(3)
         @requests_in_flight = 0
-
-        if options[:threads] != false
-          @outlet_thread = Thread.new { outlet }
-          @flush_thread = Thread.new { intervaled_flush }
-        end
       end
 
       # Write a new log line message to the buffer, and deliver if the msg exceeds the
       # payload limit.
       def write(msg)
         @msg_queue.enqueue(msg)
+
+        # Lazily start flush threads to ensure threads are alive after forking processes.
+        # If the threads are started during instantiation they will not be copied when
+        # the current process is forked. This is the case with various web servers,
+        # such as phusion passenger.
+        ensure_flush_threads_are_started
+
         if @msg_queue.full?
           debug_logger.debug("Flushing timber buffer via write") if debug_logger
           flush
@@ -129,6 +139,19 @@ module Timber
         true
       end
 
+      def flush
+        @last_flush = Time.now
+        msgs = @msg_queue.flush
+        return if msgs.empty?
+
+        req = Net::HTTP::Post.new(@timber_url.path)
+        req['Authorization'] = authorization_payload
+        req['Content-Type'] = CONTENT_TYPE
+        req['User-Agent'] = USER_AGENT
+        req.body = msgs.to_msgpack
+        @request_queue.enq(req)
+      end
+
       # Closes the log device, cleans up, and attempts one last delivery.
       def close
         @flush_thread.kill if @flush_thread
@@ -141,17 +164,20 @@ module Timber
           Timber::Config.instance.debug_logger
         end
 
-        def flush
-          @last_flush = Time.now
-          msgs = @msg_queue.flush
-          return if msgs.empty?
-
-          req = Net::HTTP::Post.new(@timber_url.path)
-          req['Authorization'] = authorization_payload
-          req['Content-Type'] = CONTENT_TYPE
-          req['User-Agent'] = USER_AGENT
-          req.body = msgs.to_msgpack
-          @request_queue.enq(req)
+        # This is a convenience method to ensure the flush thread are
+        # started. This is called lazily from #write so that we
+        # only start the threads as needed, but it also ensures
+        # threads are started after process forking.
+        def ensure_flush_threads_are_started
+          if @flush_continuously
+            if @outlet_thread.nil? || !@outlet_thread.alive?
+              @outlet_thread = Thread.new { outlet }
+            end
+
+            if @flush_thread.nil? || !@flush_thread.alive?
+              @flush_thread = Thread.new { intervaled_flush }
+            end
+          end
         end
 
         def intervaled_flush

data/lib/timber/log_entry.rb

@@ -5,7 +5,7 @@ module Timber
   # `Logger` and the log device that you set it up with.
   class LogEntry #:nodoc:
     DT_PRECISION = 6.freeze
-    SCHEMA = "https://raw.githubusercontent.com/timberio/log-event-json-schema/2.0.1/schema.json".freeze
+    SCHEMA = "https://raw.githubusercontent.com/timberio/log-event-json-schema/v2.0.4/schema.json".freeze
 
     attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time, :time_ms
 

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.0.19"
+  VERSION = "2.0.20"
 end

data/spec/timber/log_devices/http_spec.rb

@@ -1,13 +1,18 @@
 require "spec_helper"
 
+# Note: these tests access instance variables and private methods as a means of
+# not muddying the public API. This object should expose a simple buffer like
+# API, tests should not alter that.
 describe Timber::LogDevices::HTTP do
   describe "#initialize" do
     it "should initialize properly" do
       http = described_class.new("MYKEY", flush_interval: 0.1)
+
+      # Ensure that threads have not started
       thread = http.instance_variable_get(:@flush_thread)
-      expect(thread).to be_alive
-      thread = http.instance_variable_get(:@flush_thread)
-      expect(thread).to be_alive
+      expect(thread).to be_nil
+      thread = http.instance_variable_get(:@outlet_thread)
+      expect(thread).to be_nil
     end
   end
 
@@ -20,6 +25,15 @@ describe Timber::LogDevices::HTTP do
       expect(msg_queue.flush).to eq(["test log message"])
     end
 
+    it "should start the flush threads" do
+      http.write("test log message")
+
+      thread = http.instance_variable_get(:@flush_thread)
+      expect(thread).to be_alive
+      thread = http.instance_variable_get(:@outlet_thread)
+      expect(thread).to be_alive
+    end
+
     context "with a low batch size" do
       let(:http) { described_class.new("MYKEY", :batch_size => 2) }
 
@@ -35,6 +49,7 @@ describe Timber::LogDevices::HTTP do
     let(:http) { described_class.new("MYKEY") }
 
     it "should kill the threads" do
+      http.send(:ensure_flush_threads_are_started)
       http.close
       thread = http.instance_variable_get(:@flush_thread)
       sleep 0.1 # too fast!
@@ -57,7 +72,7 @@ describe Timber::LogDevices::HTTP do
     let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
 
     it "should add a request to the queue" do
-      http = described_class.new("MYKEY", threads: false)
+      http = described_class.new("MYKEY", flush_continuously: false)
       log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 1", nil, nil)
       http.write(log_entry)
       log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 2", nil, nil)
@@ -73,7 +88,7 @@ describe Timber::LogDevices::HTTP do
     end
 
     it "should preserve formatting for mshpack payloads" do
-      http = described_class.new("MYKEY", threads: false)
+      http = described_class.new("MYKEY", flush_continuously: false)
       http.write("This is a log message 1".to_msgpack)
       http.write("This is a log message 2".to_msgpack)
       http.send(:flush)
@@ -84,9 +99,10 @@ describe Timber::LogDevices::HTTP do
   describe "#intervaled_flush" do
     it "should start a intervaled flush thread and flush on an interval" do
       http = described_class.new("MYKEY", flush_interval: 0.1)
+      http.send(:ensure_flush_threads_are_started)
       expect(http).to receive(:flush).exactly(1).times
       sleep 0.12 # too fast!
-      mock = expect(http).to receive(:flush).exactly(1).times
+      expect(http).to receive(:flush).exactly(1).times
       sleep 0.12 # too fast!
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.0.19
+  version: 2.0.20
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-15 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -264,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Log Better. Solve Problems Faster. https://timber.io