logstash_writer 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 646455172093377861ec1c62178b4aca74473a8a816929ddfb33aafc0df959ef
-  data.tar.gz: dc6b57317bf8881e29606cb1fe784a3dd2e591e331156589cdfc80eb6e562862
+  metadata.gz: 0dddb7bf146e8698d1bdebfb0deb5b3de55be252787b7d8a888624e4c63e97b4
+  data.tar.gz: 988d074dcdf5023010d0f480f15431d721a8dfdaf20c527433e72c7d7e9238c9
 SHA512:
-  metadata.gz: 8583e8677dc1c238f4030a0a5e3f63b5b75319c17b9d81249f962d9e0b33e828b1bcdd4eaebd5a2104082d014bd7abf7c5332751efa2985bc4105b4ad86dd743
-  data.tar.gz: a99a3f8b3a0cc10033f110f9e047d30cc0d0a630cca536d36cb5502a1b3461c04721cc6ef063edd2da85ea7276f8b4b57c591b112b97f530d5f874d7bd1c8c82
+  metadata.gz: da8f334ad24b00e5dba960654235bab9cfe738efaed27986fa76d09730a8889b447f9db5722b370eb9a4a2c8ccca389ef28512887c315aec38546a98a01aee39
+  data.tar.gz: ccc715f7bc30a718d6c6383b5ee76f2da186687440a8b1e6efee3aa72793bbe8975aa50a9124aa480d525e3dcb6fbde7f5272915706d06a1804fe361ebc5af4a

data/.editorconfig

@@ -0,0 +1,7 @@
+[*.rb]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true

data/lib/logstash_writer.rb

@@ -74,19 +74,19 @@ class LogstashWriter
     @server_name, @logger, @backlog = server_name, logger, backlog
 
     @metrics = {
-      received:            metrics_registry.counter(:"#{metrics_prefix}_events_received_total", "The number of logstash events which have been submitted for delivery"),
-      sent:                metrics_registry.counter(:"#{metrics_prefix}_events_written_total", "The number of logstash events which have been delivered to the logstash server"),
-      queue_size:          metrics_registry.gauge(:"#{metrics_prefix}_queue_size", "The number of events currently in the queue to be sent"),
-      dropped:             metrics_registry.counter(:"#{metrics_prefix}_events_dropped_total", "The number of events which have been dropped from the queue"),
+      received: metrics_registry.counter(:"#{metrics_prefix}_events_received_total", "The number of logstash events which have been submitted for delivery"),
+      sent: metrics_registry.counter(:"#{metrics_prefix}_events_written_total", "The number of logstash events which have been delivered to the logstash server"),
+      queue_size: metrics_registry.gauge(:"#{metrics_prefix}_queue_size", "The number of events currently in the queue to be sent"),
+      dropped: metrics_registry.counter(:"#{metrics_prefix}_events_dropped_total", "The number of events which have been dropped from the queue"),
 
-      lag:                 metrics_registry.gauge(:"#{metrics_prefix}_last_sent_event_time_seconds", "When the last event successfully sent to logstash was originally received"),
+      lag: metrics_registry.gauge(:"#{metrics_prefix}_last_sent_event_time_seconds", "When the last event successfully sent to logstash was originally received"),
 
-      connected:           metrics_registry.gauge(:"#{metrics_prefix}_connected_to_server", "Boolean flag indicating whether we are currently connected to a logstash server"),
-      connect_exception:   metrics_registry.counter(:"#{metrics_prefix}_connect_exceptions_total", "The number of exceptions that have occurred whilst attempting to connect to a logstash server"),
-      write_exception:     metrics_registry.counter(:"#{metrics_prefix}_write_exceptions_total", "The number of exceptions that have occurred whilst attempting to write an event to a logstash server"),
+      connected: metrics_registry.gauge(:"#{metrics_prefix}_connected_to_server", "Boolean flag indicating whether we are currently connected to a logstash server"),
+      connect_exception: metrics_registry.counter(:"#{metrics_prefix}_connect_exceptions_total", "The number of exceptions that have occurred whilst attempting to connect to a logstash server"),
+      write_exception: metrics_registry.counter(:"#{metrics_prefix}_write_exceptions_total", "The number of exceptions that have occurred whilst attempting to write an event to a logstash server"),
 
       write_loop_exception: metrics_registry.counter(:"#{metrics_prefix}_write_loop_exceptions_total", "The number of exceptions that have occurred in the writing loop"),
-      write_loop_ok:        metrics_registry.gauge(:"#{metrics_prefix}_write_loop_ok", "Boolean flag indicating whether the writing loop is currently operating correctly, or is in a post-apocalyptic hellscape of never-ending exceptions"),
+      write_loop_ok: metrics_registry.gauge(:"#{metrics_prefix}_write_loop_ok", "Boolean flag indicating whether the writing loop is currently operating correctly, or is in a post-apocalyptic hellscape of never-ending exceptions"),
     }
 
     @metrics[:lag].set({}, 0)
@@ -136,6 +136,33 @@ class LogstashWriter
     nil
   end
 
+  # Send events.
+  #
+  # Does not return until `#shutdown` is called (in another thread).
+  #
+  def run
+    @queue_mutex.synchronize do
+      @terminate = false
+    end
+
+    write_loop
+  end
+
+  # Tell the LogstashWriter to flush its queue and terminate operation.
+  #
+  # Returns immediately.
+  #
+  def shutdown
+    #:nocov:
+    @worker_mutex.synchronize do
+      @queue_mutex.synchronize do
+        @terminate = true
+        @queue_cv.signal
+      end
+    end
+    #:nocov:
+  end
+
   # Start sending events.
   #
   # This method will return almost immediately, and actual event
@@ -143,11 +170,14 @@ class LogstashWriter
   #
   # @return [NilClass]
   #
-  def run
+  def start!
     @worker_mutex.synchronize do
       if @worker_thread.nil?
+        @queue_mutex.synchronize do
+          @terminate = false
+        end
+
         @worker_thread = Thread.new do
-          Thread.current.name = "LogstashWriter"
           write_loop
         end
       end
@@ -164,18 +194,19 @@ class LogstashWriter
   #
   # @return [NilClass]
   #
-  def stop
+  def stop!
     @worker_mutex.synchronize do
       if @worker_thread
-        @terminate = true
-        @queue_cv.signal
+        @queue_mutex.synchronize do
+          @terminate = true
+          @queue_cv.signal
+        end
         begin
-          @worker_thread.join
+          @worker_thread.join unless @worker_thread == Thread.current
         rescue Exception => ex
           @logger.error("LogstashWriter") { (["Worker thread terminated with exception: #{ex.message} (#{ex.class})"] + ex.backtrace).join("\n  ") }
         end
         @worker_thread = nil
-        @socket_mutex.synchronize { (@current_target.close; @current_target = nil) if @current_target }
       end
     end
 
@@ -210,45 +241,43 @@ class LogstashWriter
   #
   def write_loop
     error_wait = INITIAL_RETRY_WAIT
+    Thread.current.name = "LogstashWriter"
 
-    catch :terminate do
-      loop do
-        event = nil
+    until @terminate do
+      event = nil
 
-        begin
-          @queue_mutex.synchronize do
-            while @queue.empty? && !@terminate
-              @queue_cv.wait(@queue_mutex)
-            end
-
-            if @queue.empty? && @terminate
-              @terminate = false
-              throw :terminate
-            end
-
-            event = @queue.shift
+      begin
+        @queue_mutex.synchronize do
+          while @queue.empty? && !@terminate
+            @queue_cv.wait(@queue_mutex)
           end
 
+          event = @queue.shift
+        end
+
+        if event
           current_target do |t|
             t.socket.puts event[:content].to_json
             stat_sent(t.to_s, event[:arrival_timestamp])
             @metrics[:write_loop_ok].set({}, 1)
             error_wait = INITIAL_RETRY_WAIT
           end
-        rescue StandardError => ex
-          @logger.error("LogstashWriter") { (["Exception in write_loop: #{ex.message} (#{ex.class})"] + ex.backtrace).join("\n  ") }
-          @queue_mutex.synchronize { @queue.unshift(event) if event }
-          @metrics[:write_loop_exception].increment(class: ex.class.to_s)
-          @metrics[:write_loop_ok].set({}, 0)
-          sleep error_wait
-          # Increase the error wait timeout for next time, up to a maximum
-          # interval of about 60 seconds
-          error_wait *= 1.1
-          error_wait = 60 if error_wait > 60
-          error_wait += rand / 0.5
         end
+      rescue StandardError => ex
+        @logger.error("LogstashWriter") { (["Exception in write_loop: #{ex.message} (#{ex.class})"] + ex.backtrace).join("\n  ") }
+        @queue_mutex.synchronize { @queue.unshift(event) if event }
+        @metrics[:write_loop_exception].increment(class: ex.class.to_s)
+        @metrics[:write_loop_ok].set({}, 0)
+        sleep error_wait
+        # Increase the error wait timeout for next time, up to a maximum
+        # interval of about 60 seconds
+        error_wait *= 1.1
+        error_wait = 60 if error_wait > 60
+        error_wait += rand / 0.5
       end
     end
+
+    force_disconnect!
   end
 
   # Yield a Target connected to the server we currently believe to be

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash_writer
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -202,6 +202,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -230,8 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Opinionated logstash event pump