log-courier 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e7cf906de75f2ac3838d007c24380f0e8a3740
-  data.tar.gz: dadf3d48bb4302f35be2255e1d168bb1699cde04
+  metadata.gz: 18d64c60c7561492f74be1a92bb7ef4cce3d2a98
+  data.tar.gz: 71f010bef4d7c535e453dab752c83830169952ea
 SHA512:
-  metadata.gz: 5eae260c97dc6d05ffca1c7160aaeb153289020e289335948a5ca3fc96019c2b418a8fe6d5846ad53ca7b7f9a569d3679acc870f40743f14f86618ac97ac6c9e
-  data.tar.gz: 16fe209e290aedb5fefc707733d5860889dbb3a11ff4900b1c04543729bf184072142250ab9bdca398f1363052ce11c5d94645a00ca4ec108338b74cb106dd94
+  metadata.gz: f87ec04d3cc8e91c5e4257157f9a90112ca34d210fbf7bdac4ac78c58068c7dd529e14657947e150996ebc6dd85f3047524fe0d937426f656a742ab1c75dfc50
+  data.tar.gz: 6f82c4989b768bf644683b568f4e8fbc572506e0344093c5ed149e06a00848480bb20437ac1749f515709f66b9a1933ff9267f48afaa709496010abe4361e3d3

data/lib/log-courier/client.rb

@@ -42,7 +42,7 @@ module LogCourier
       @ack_events = 0
 
       options.each do |k, v|
-        raise ArgumentError unless self.respond_to?(k)
+        fail ArgumentError unless self.respond_to?(k)
         instance_variable_set "@#{k}", v
       end
     end
@@ -58,6 +58,7 @@ module LogCourier
       }.merge!(options)
 
       @logger = @options[:logger]
+      @logger['plugin'] = 'output/courier'
 
       require 'log-courier/client_tls'
       @client = ClientTls.new(@options)
@@ -90,6 +91,7 @@ module LogCourier
     def publish(event)
       # Pass the event into the spooler
       @event_queue << event
+      return
     end
 
     def shutdown
@@ -98,8 +100,11 @@ module LogCourier
       @io_thread.raise ShutdownSignal
       @spooler_thread.join
       @io_thread.join
+      return
     end
 
+    private
+
     def run_spooler
       loop do
         spooled = []
@@ -124,9 +129,9 @@ module LogCourier
           @io_control << ['E', spooled]
         end
       end
+      return
     rescue ShutdownSignal
-      # Just shutdown
-      0
+      return
     end
 
     def run_io
@@ -207,12 +212,12 @@ module LogCourier
                 # Keepalive timeout hit, send a PING unless we were awaiting a PONG
                 if @pending_ping
                   # Timed out, break into reconnect
-                  raise TimeoutError
+                  fail TimeoutError
                 end
 
                 # Is send full? can_send will be false if so
                 # We should've started receiving ACK by now so time out
-                raise TimeoutError unless can_send
+                fail TimeoutError unless can_send
 
                 # Send PING
                 send_ping
@@ -227,17 +232,16 @@ module LogCourier
           end
         rescue ProtocolError => e
           # Reconnect required due to a protocol error
-          @logger.warn("[LogCourierClient] Protocol error: #{e}") unless @logger.nil?
+          @logger.warn 'Protocol error', :error => e.message unless @logger.nil?
         rescue TimeoutError
           # Reconnect due to timeout
-          @logger.warn('[LogCourierClient] Timeout occurred') unless @logger.nil?
+          @logger.warn 'Timeout occurred' unless @logger.nil?
         rescue ShutdownSignal
           # Shutdown, break out
           break
-        rescue => e
+        rescue StandardError, NativeException => e
           # Unknown error occurred
-          @logger.warn("[LogCourierClient] Unknown error: #{e}") unless @logger.nil?
-          @logger.warn("[LogCourierClient] #{e.backtrace}: #{e.message} (#{e.class})") unless @logger.nil?
+          @logger.warn e, :hint => 'Unknown error' unless @logger.nil?
         end
 
         # Disconnect and retry payloads
@@ -249,10 +253,12 @@ module LogCourier
       end
 
       @client.disconnect
+      return
     end
 
     def reset_keepalive
       @keepalive_next = Time.now.to_i + @keepalive_timeout
+      return
     end
 
     def generate_nonce
@@ -262,6 +268,7 @@ module LogCourier
     def send_ping
       # Send it
       @client.send 'PING', ''
+      return
     end
 
     def send_jdat(events)
@@ -288,6 +295,7 @@ module LogCourier
 
       # Send it
       @client.send 'JDAT', payload.data
+      return
     end
 
     def buffer_jdat_data(events, nonce)
@@ -307,23 +315,21 @@ module LogCourier
 
       # Add length and then the data
       buffer << [json_data.length].pack('N') << json_data
+      return
     end
 
     def process_pong(message)
       # Sanity
-      if message.length != 0
-        raise ProtocolError, "Unexpected data attached to pong message (#{message.length})"
-      end
+      fail ProtocolError, "Unexpected data attached to pong message (#{message.length})" if message.length != 0
 
       # No longer pending a PONG
       @ping_pending = false
+      return
     end
 
     def process_ackn(message)
       # Sanity
-      if message.length != 20
-        raise ProtocolError, "ACKN message size invalid (#{message.length})"
-      end
+      fail ProtocolError, "ACKN message size invalid (#{message.length})" if message.length != 20
 
       # Grab nonce
       sequence, nonce = message[0...4].unpack('N').first, message[4..-1]
@@ -348,6 +354,7 @@ module LogCourier
           payload.data = nil
         end
       end
+      return
     end
   end
 end

data/lib/log-courier/client_tls.rb

@@ -38,17 +38,17 @@ module LogCourier
       @logger = @options[:logger]
 
       [:port, :ssl_ca].each do |k|
-        raise "[LogCourierClient] '#{k}' is required" if @options[k].nil?
+        fail "output/courier: '#{k}' is required" if @options[k].nil?
       end
 
-      raise '[LogCourierClient] \'addresses\' must contain at least one address' if @options[:addresses].empty?
+      fail 'output/courier: \'addresses\' must contain at least one address' if @options[:addresses].empty?
 
       c = 0
       [:ssl_certificate, :ssl_key].each do
         c += 1
       end
 
-      raise '[LogCourierClient] \'ssl_certificate\' and \'ssl_key\' must be specified together' if c == 1
+      fail 'output/courier: \'ssl_certificate\' and \'ssl_key\' must be specified together' if c == 1
     end
 
     def connect(io_control)
@@ -71,6 +71,7 @@ module LogCourier
       @recv_thread = Thread.new do
         run_recv io_control
       end
+      return
     end
 
     def disconnect
@@ -78,8 +79,17 @@ module LogCourier
       @send_thread.join
       @recv_thread.raise ShutdownSignal
       @recv_thread.join
+      return
     end
 
+    def send(signature, message)
+      # Add to send queue
+      @send_q << [signature, message.length].pack('A4N') + message
+      return
+    end
+
+    private
+
     def run_send(io_control)
       # Ask for something to send
       io_control << ['S']
@@ -108,29 +118,31 @@ module LogCourier
           @ssl_client.write message
         end
       end
+      return
     rescue OpenSSL::SSL::SSLError, IOError, Errno::ECONNRESET => e
-      @logger.warn("[LogCourierClient] SSL write error: #{e}") unless @logger.nil?
+      @logger.warn 'SSL write error', :error => e.message unless @logger.nil?
       io_control << ['F']
+      return
     rescue ShutdownSignal
-      # Just shutdown
-    rescue => e
-      @logger.warn("[LogCourierClient] Unknown SSL write error: #{e}") unless @logger.nil?
-      @logger.warn("[LogCourierClient] #{e.backtrace}: #{e.message} (#{e.class})") unless @logger.nil?
+      return
+    rescue StandardError, NativeException => e
+      @logger.warn e, :hint => 'Unknown SSL write error' unless @logger.nil?
       io_control << ['F']
+      return
     end
 
     def run_recv(io_control)
       loop do
         # Grab a header
         header = @ssl_client.read(8)
-        raise EOFError if header.nil?
+        fail EOFError if header.nil?
 
         # Decode signature and length
         signature, length = header.unpack('A4N')
 
         if length > 1048576
           # Too big raise error
-          @logger.warn("[LogCourierClient] Invalid message: data too big (#{length})") unless @logger.nil?
+          @logger.warn 'Invalid message: data too big', :data_length => length unless @logger.nil?
           io_control << ['F']
           break
         end
@@ -141,29 +153,28 @@ module LogCourier
         # Pass through to receive
         io_control << ['R', signature, message]
       end
+      return
     rescue OpenSSL::SSL::SSLError, IOError, Errno::ECONNRESET => e
-      @logger.warn("[LogCourierClient] SSL read error: #{e}") unless @logger.nil?
+      @logger.warn 'SSL read error', :error => e.message unless @logger.nil?
       io_control << ['F']
+      return
     rescue EOFError
-      @logger.warn("[LogCourierClient] Connection closed by server") unless @logger.nil?
+      @logger.warn 'Connection closed by server' unless @logger.nil?
       io_control << ['F']
+      return
     rescue ShutdownSignal
-      # Just shutdown
+      return
     rescue => e
-      @logger.warn("[LogCourierClient] Unknown SSL read error: #{e}") unless @logger.nil?
-      @logger.warn("[LogCourierClient] #{e.backtrace}: #{e.message} (#{e.class})") unless @logger.nil?
+      @logger.warn e, :hint => 'Unknown SSL read error' unless @logger.nil?
       io_control << ['F']
-    end
-
-    def send(signature, message)
-      # Add to send queue
-      @send_q << [signature, message.length].pack('A4N') + message
+      return
     end
 
     def pause_send
       return if @send_paused
       @send_paused = true
       @send_q << nil
+      return
     end
 
     def send_paused
@@ -175,44 +186,53 @@ module LogCourier
         @send_paused = false
         @send_q << nil
       end
+      return
     end
 
     def tls_connect
       # TODO: Implement random selection - and don't use separate :port - remember to update post_connection_check too
-      @logger.info("[LogCourierClient] Connecting to #{@options[:addresses][0]}:#{@options[:port]}") unless @logger.nil?
-      tcp_socket = TCPSocket.new(@options[:addresses][0], @options[:port])
+      address = @options[:addresses][0]
+      port = @options[:port]
 
-      ssl = OpenSSL::SSL::SSLContext.new
+      @logger.info 'Connecting', :address => address, :port => port unless @logger.nil?
 
-      unless @options[:ssl_certificate].nil?
-        ssl.cert = OpenSSL::X509::Certificate.new(File.read(@options[:ssl_certificate]))
-        ssl.key = OpenSSL::PKey::RSA.new(File.read(@options[:ssl_key]), @options[:ssl_key_passphrase])
-      end
+      begin
+        tcp_socket = TCPSocket.new(address, port)
 
-      cert_store = OpenSSL::X509::Store.new
-      cert_store.add_file(@options[:ssl_ca])
-      #ssl.cert_store = cert_store
-      ssl.verify_mode = OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+        ssl = OpenSSL::SSL::SSLContext.new
 
-      @ssl_client = OpenSSL::SSL::SSLSocket.new(tcp_socket)
+        unless @options[:ssl_certificate].nil?
+          ssl.cert = OpenSSL::X509::Certificate.new(File.read(@options[:ssl_certificate]))
+          ssl.key = OpenSSL::PKey::RSA.new(File.read(@options[:ssl_key]), @options[:ssl_key_passphrase])
+        end
 
-      socket = @ssl_client.connect
+        cert_store = OpenSSL::X509::Store.new
+        cert_store.add_file(@options[:ssl_ca])
+        #ssl.cert_store = cert_store
+        ssl.verify_mode = OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
 
-      # Verify certificate
-      socket.post_connection_check(@options[:addresses][0])
+        @ssl_client = OpenSSL::SSL::SSLSocket.new(tcp_socket)
 
-      @logger.info("[LogCourierClient] Connected successfully") unless @logger.nil?
+        socket = @ssl_client.connect
 
-      socket
-    rescue OpenSSL::SSL::SSLError, IOError, Errno::ECONNRESET => e
-      @logger.warn("[LogCourierClient] Connection to #{@options[:addresses][0]}:#{@options[:port]} failed: #{e}") unless @logger.nil?
-    rescue ShutdownSignal
-      # Just shutdown
-      0
-    rescue StandardError, NativeException => e
-      @logger.warn("[LogCourierClient] Unknown connection failure to #{@options[:addresses][0]}:#{@options[:port]}: #{e}") unless @logger.nil?
-      @logger.warn("[LogCourierClient] #{e.backtrace}: #{e.message} (#{e.class})") unless @logger.nil?
-      raise e
+        # Verify certificate
+        socket.post_connection_check(address)
+
+        # Add extra logging data now we're connected
+        @logger['address'] = address
+        @logger['port'] = port
+
+        @logger.info 'Connected successfully' unless @logger.nil?
+        return
+      rescue OpenSSL::SSL::SSLError, IOError, Errno::ECONNRESET => e
+        @logger.warn 'Connection failed', :error => e.message, :address => address, :port => port unless @logger.nil?
+        return
+      rescue ShutdownSignal
+        return
+      rescue StandardError, NativeException => e
+        @logger.warn e, :hint => 'Unknown connection failure', :address => address, :port => port unless @logger.nil?
+        raise e
+      end
     end
   end
 end

data/lib/log-courier/event_queue.rb

@@ -33,7 +33,7 @@ module LogCourier
     # Creates a fixed-length queue with a maximum size of +max+.
     #
     def initialize(max)
-      raise ArgumentError, "queue size must be positive" unless max > 0
+      fail ArgumentError, "queue size must be positive" unless max > 0
       @max = max
       @enque_cond = ConditionVariable.new
       @num_enqueue_waiting = 0
@@ -44,20 +44,19 @@ module LogCourier
       self.taint
       @mutex = Mutex.new
       @cond = ConditionVariable.new
+      return
     end
 
     #
     # Returns the maximum size of the queue.
     #
-    def max
-      @max
-    end
+    attr_reader :max
 
     #
     # Sets the maximum size of the queue.
     #
     def max=(max)
-      raise ArgumentError, "queue size must be positive" unless max > 0
+      fail ArgumentError, "queue size must be positive" unless max > 0
 
       @mutex.synchronize do
         if max <= @max
@@ -90,7 +89,7 @@ module LogCourier
           ensure
             @num_enqueue_waiting -= 1
           end
-          raise TimeoutError if !timeout.nil? and Time.now - start >= timeout
+          fail TimeoutError if !timeout.nil? and Time.now - start >= timeout
         end
 
         @que.push obj
@@ -113,7 +112,7 @@ module LogCourier
     # Retrieves data from the queue and runs a waiting thread, if any.
     #
     def pop(*args)
-      retval = _pop_timeout *args
+      retval = pop_timeout *args
       @mutex.synchronize do
         if @que.length < @max
           @enque_cond.signal
@@ -122,31 +121,6 @@ module LogCourier
       retval
     end
 
-    #
-    # Retrieves data from the queue.  If the queue is empty, the calling thread is
-    # suspended until data is pushed onto the queue or, if set, +timeout+ seconds
-    # passes.  If +timeout+ is 0, the thread isn't suspended, and an exception is
-    # raised.
-    #
-    def _pop_timeout(timeout = nil)
-      unless timeout.nil?
-        start = Time.now
-      end
-      @mutex.synchronize do
-        loop do
-          return @que.shift unless @que.empty?
-          raise TimeoutError if timeout == 0
-          begin
-            @num_waiting += 1
-            @cond.wait @mutex, timeout
-          ensure
-            @num_waiting -= 1
-          end
-          raise TimeoutError if !timeout.nil? and Time.now - start >= timeout
-        end
-      end
-    end
-
     #
     # Alias of pop
     #
@@ -190,5 +164,33 @@ module LogCourier
     def num_waiting
       @num_waiting + @num_enqueue_waiting
     end
+
+    private
+
+    #
+    # Retrieves data from the queue.  If the queue is empty, the calling thread is
+    # suspended until data is pushed onto the queue or, if set, +timeout+ seconds
+    # passes.  If +timeout+ is 0, the thread isn't suspended, and an exception is
+    # raised.
+    #
+    def pop_timeout(timeout = nil)
+      unless timeout.nil?
+        start = Time.now
+      end
+      @mutex.synchronize do
+        loop do
+          return @que.shift unless @que.empty?
+          fail TimeoutError if timeout == 0
+          begin
+            @num_waiting += 1
+            @cond.wait @mutex, timeout
+          ensure
+            @num_waiting -= 1
+          end
+          fail TimeoutError if !timeout.nil? and Time.now - start >= timeout
+        end
+      end
+      return
+    end
   end
 end