semantic_logger 4.2.0 → 4.2.1

data/lib/semantic_logger/appender/http.rb

@@ -16,206 +16,210 @@ require 'openssl'
 #     appender: :http,
 #     url:      'http://localhost:8088/path'
 #   )
-class SemanticLogger::Appender::Http < SemanticLogger::Subscriber
-  attr_accessor :username, :compress, :header,
-                :open_timeout, :read_timeout, :continue_timeout
-  attr_reader :http, :url, :server, :port, :path, :ssl_options
-
-  # Create HTTP(S) log appender
-  #
-  # Parameters:
-  #   url: [String]
-  #     Valid URL to post to.
-  #       Example: http://example.com/some_path
-  #     To enable SSL include https in the URL.
-  #       Example: https://example.com/some_path
-  #       verify_mode will default: OpenSSL::SSL::VERIFY_PEER
-  #
-  #   application: [String]
-  #     Name of this application to appear in log messages.
-  #     Default: SemanticLogger.application
-  #
-  #   host: [String]
-  #     Name of this host to appear in log messages.
-  #     Default: SemanticLogger.host
-  #
-  #   username: [String]
-  #     User name for basic Authentication.
-  #     Default: nil ( do not use basic auth )
-  #
-  #   password: [String]
-  #     Password for basic Authentication.
-  #
-  #   compress: [true|false]
-  #     Whether to compress the JSON string with GZip.
-  #     Default: false
-  #
-  #   ssl: [Hash]
-  #     Specific SSL options: For more details see NET::HTTP.start
-  #       ca_file, ca_path, cert, cert_store, ciphers, key, ssl_timeout,
-  #       ssl_version, verify_callback, verify_depth and verify_mode.
-  #
-  #   level: [:trace | :debug | :info | :warn | :error | :fatal]
-  #     Override the log level for this appender.
-  #     Default: SemanticLogger.default_level
-  #
-  #   formatter: [Object|Proc]
-  #     An instance of a class that implements #call, or a Proc to be used to format
-  #     the output from this appender
-  #     Default: Use the built-in formatter (See: #call)
-  #
-  #   filter: [Regexp|Proc]
-  #     RegExp: Only include log messages where the class name matches the supplied.
-  #     regular expression. All other messages will be ignored.
-  #     Proc: Only include log messages where the supplied Proc returns true
-  #           The Proc must return true or false.
-  #
-  #   open_timeout: [Float]
-  #     Default: 2.0
-  #
-  #   read_timeout: [Float]
-  #     Default: 1.0
-  #
-  #   continue_timeout: [Float]
-  #     Default: 1.0
-  def initialize(url:,
-                 compress: false,
-                 ssl: {},
-                 username: nil,
-                 password: nil,
-                 open_timeout: 2.0,
-                 read_timeout: 1.0,
-                 continue_timeout: 1.0,
-                 level: nil,
-                 formatter: nil,
-                 filter: nil,
-                 application: nil,
-                 host: nil,
-                 &block)
-
-    @url              = url
-    @ssl_options      = ssl
-    @username         = username
-    @password         = password
-    @compress         = compress
-    @open_timeout     = open_timeout
-    @read_timeout     = read_timeout
-    @continue_timeout = continue_timeout
-
-    # On Ruby v2.0 and greater, Net::HTTP.new already uses a persistent connection if the server allows it
-    @header                     = {
-      'Accept'       => 'application/json',
-      'Content-Type' => 'application/json',
-      'Connection'   => 'keep-alive',
-      'Keep-Alive'   => '300'
-    }
-    @header['Content-Encoding'] = 'gzip' if @compress
-
-    uri     = URI.parse(@url)
-    @server = uri.host
-    raise(ArgumentError, "Invalid format for :url: #{@url.inspect}. Should be similar to: 'http://hostname:port/path'") unless @server
-
-    @port     = uri.port
-    @username = uri.user if !@username && uri.user
-    @password = uri.password if !@password && uri.password
-    @path     = uri.path
-    # Path cannot be empty
-    @path     = '/' if @path == ''
-
-    if uri.scheme == 'https'
-      @ssl_options[:use_ssl]     = true
-      @ssl_options[:verify_mode] ||= OpenSSL::SSL::VERIFY_PEER
-      @port                      ||= HTTP.https_default_port
-    else
-      @port ||= HTTP.http_default_port
-    end
-    @http = nil
-
-    super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
-    reopen
-  end
-
-  # Re-open after process fork
-  def reopen
-    # Close open connection if any
-    begin
-      @http.finish if @http
-    rescue IOError
-    end
-
-    @http = Net::HTTP.new(server, port)
-
-    if @ssl_options
-      @http.methods.grep(/\A(\w+)=\z/) do |meth|
-        key = $1.to_sym
-        @ssl_options.key?(key) or next
-        @http.__send__(meth, @ssl_options[key])
+module SemanticLogger
+  module Appender
+    class Http < SemanticLogger::Subscriber
+      attr_accessor :username, :compress, :header,
+                    :open_timeout, :read_timeout, :continue_timeout
+      attr_reader :http, :url, :server, :port, :path, :ssl_options
+
+      # Create HTTP(S) log appender
+      #
+      # Parameters:
+      #   url: [String]
+      #     Valid URL to post to.
+      #       Example: http://example.com/some_path
+      #     To enable SSL include https in the URL.
+      #       Example: https://example.com/some_path
+      #       verify_mode will default: OpenSSL::SSL::VERIFY_PEER
+      #
+      #   application: [String]
+      #     Name of this application to appear in log messages.
+      #     Default: SemanticLogger.application
+      #
+      #   host: [String]
+      #     Name of this host to appear in log messages.
+      #     Default: SemanticLogger.host
+      #
+      #   username: [String]
+      #     User name for basic Authentication.
+      #     Default: nil ( do not use basic auth )
+      #
+      #   password: [String]
+      #     Password for basic Authentication.
+      #
+      #   compress: [true|false]
+      #     Whether to compress the JSON string with GZip.
+      #     Default: false
+      #
+      #   ssl: [Hash]
+      #     Specific SSL options: For more details see NET::HTTP.start
+      #       ca_file, ca_path, cert, cert_store, ciphers, key, ssl_timeout,
+      #       ssl_version, verify_callback, verify_depth and verify_mode.
+      #
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: SemanticLogger.default_level
+      #
+      #   formatter: [Object|Proc]
+      #     An instance of a class that implements #call, or a Proc to be used to format
+      #     the output from this appender
+      #     Default: Use the built-in formatter (See: #call)
+      #
+      #   filter: [Regexp|Proc]
+      #     RegExp: Only include log messages where the class name matches the supplied.
+      #     regular expression. All other messages will be ignored.
+      #     Proc: Only include log messages where the supplied Proc returns true
+      #           The Proc must return true or false.
+      #
+      #   open_timeout: [Float]
+      #     Default: 2.0
+      #
+      #   read_timeout: [Float]
+      #     Default: 1.0
+      #
+      #   continue_timeout: [Float]
+      #     Default: 1.0
+      def initialize(url:,
+                     compress: false,
+                     ssl: {},
+                     username: nil,
+                     password: nil,
+                     open_timeout: 2.0,
+                     read_timeout: 1.0,
+                     continue_timeout: 1.0,
+                     level: nil,
+                     formatter: nil,
+                     filter: nil,
+                     application: nil,
+                     host: nil,
+                     &block)
+
+        @url              = url
+        @ssl_options      = ssl
+        @username         = username
+        @password         = password
+        @compress         = compress
+        @open_timeout     = open_timeout
+        @read_timeout     = read_timeout
+        @continue_timeout = continue_timeout
+
+        # On Ruby v2.0 and greater, Net::HTTP.new already uses a persistent connection if the server allows it
+        @header                     = {
+          'Accept'       => 'application/json',
+          'Content-Type' => 'application/json',
+          'Connection'   => 'keep-alive',
+          'Keep-Alive'   => '300'
+        }
+        @header['Content-Encoding'] = 'gzip' if @compress
+
+        uri     = URI.parse(@url)
+        @server = uri.host
+        raise(ArgumentError, "Invalid format for :url: #{@url.inspect}. Should be similar to: 'http://hostname:port/path'") unless @server
+
+        @port     = uri.port
+        @username = uri.user if !@username && uri.user
+        @password = uri.password if !@password && uri.password
+        @path     = uri.path
+        # Path cannot be empty
+        @path     = '/' if @path == ''
+
+        if uri.scheme == 'https'
+          @ssl_options[:use_ssl]     = true
+          @ssl_options[:verify_mode] ||= OpenSSL::SSL::VERIFY_PEER
+          @port                      ||= HTTP.https_default_port
+        else
+          @port ||= HTTP.http_default_port
+        end
+        @http = nil
+
+        super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
+        reopen
       end
-    end
 
-    @http.open_timeout     = @open_timeout
-    @http.read_timeout     = @read_timeout
-    @http.continue_timeout = @continue_timeout
-    @http.start
-  end
+      # Re-open after process fork
+      def reopen
+        # Close open connection if any
+        begin
+          @http&.finish
+        rescue IOError
+          nil
+        end
+
+        @http = Net::HTTP.new(server, port)
+
+        if @ssl_options
+          @http.methods.grep(/\A(\w+)=\z/) do |meth|
+            key = Regexp.last_match(1).to_sym
+            @ssl_options.key?(key) || next
+            @http.__send__(meth, @ssl_options[key])
+          end
+        end
+
+        @http.open_timeout     = @open_timeout
+        @http.read_timeout     = @read_timeout
+        @http.continue_timeout = @continue_timeout
+        @http.start
+      end
 
-  # Forward log messages to HTTP Server
-  def log(log)
-    message = formatter.call(log, self)
-    logger.trace(message)
-    post(message)
-  end
+      # Forward log messages to HTTP Server
+      def log(log)
+        message = formatter.call(log, self)
+        logger.trace(message)
+        post(message)
+      end
 
-  private
+      private
 
-  # Use JSON Formatter by default
-  def default_formatter
-    SemanticLogger::Formatters::Json.new
-  end
+      # Use JSON Formatter by default
+      def default_formatter
+        SemanticLogger::Formatters::Json.new
+      end
 
-  def compress_data(data)
-    str = StringIO.new
-    gz  = Zlib::GzipWriter.new(str)
-    gz << data
-    gz.close
-    str.string
-  end
+      def compress_data(data)
+        str = StringIO.new
+        gz  = Zlib::GzipWriter.new(str)
+        gz << data
+        gz.close
+        str.string
+      end
 
-  # HTTP Post
-  def post(body, request_uri = path)
-    request = Net::HTTP::Post.new(request_uri, @header)
-    process_request(request, body)
-  end
+      # HTTP Post
+      def post(body, request_uri = path)
+        request = Net::HTTP::Post.new(request_uri, @header)
+        process_request(request, body)
+      end
 
-  # HTTP Put
-  def put(body, request_uri = path)
-    request = Net::HTTP::Put.new(request_uri, @header)
-    process_request(request, body)
-  end
+      # HTTP Put
+      def put(body, request_uri = path)
+        request = Net::HTTP::Put.new(request_uri, @header)
+        process_request(request, body)
+      end
 
-  # HTTP Delete
-  def delete(request_uri = path)
-    request = Net::HTTP::Delete.new(request_uri, @header)
-    process_request(request)
-  end
+      # HTTP Delete
+      def delete(request_uri = path)
+        request = Net::HTTP::Delete.new(request_uri, @header)
+        process_request(request)
+      end
 
-  # Process HTTP Request
-  def process_request(request, body = nil)
-    if body
-      request.body = compress ? compress_data(body) : body
-    end
-    request.basic_auth(@username, @password) if @username
-    response = @http.request(request)
-    if response.code == '200' || response.code == '201'
-      true
-    else
-      # Failures are logged to the global semantic logger failsafe logger (Usually stderr or file)
-      logger.error("Bad HTTP response from: #{url} code: #{response.code}, #{response.body}")
-      false
+      # Process HTTP Request
+      def process_request(request, body = nil)
+        if body
+          request.body = compress ? compress_data(body) : body
+        end
+        request.basic_auth(@username, @password) if @username
+        response = @http.request(request)
+        if response.code == '200' || response.code == '201'
+          true
+        else
+          # Failures are logged to the global semantic logger failsafe logger (Usually stderr or file)
+          logger.error("Bad HTTP response from: #{url} code: #{response.code}, #{response.body}")
+          false
+        end
+      rescue RuntimeError => exc
+        reopen
+        raise exc
+      end
     end
-  rescue RuntimeError => exc
-    reopen
-    raise exc
   end
-
 end

data/lib/semantic_logger/appender/kafka.rb

@@ -19,163 +19,166 @@ require 'date'
 #     # Set an optional client id in order to identify the client to Kafka:
 #     client_id: "my-application",
 #   )
-class SemanticLogger::Appender::Kafka < SemanticLogger::Subscriber
-  attr_accessor :seed_brokers, :client_id, :connect_timeout, :socket_timeout,
-                :ssl_ca_cert, :ssl_client_cert, :ssl_client_cert_key,
-                :delivery_threshold, :delivery_interval,
-                :topic, :partition, :partition_key, :key
+module SemanticLogger
+  module Appender
+    class Kafka < SemanticLogger::Subscriber
+      attr_accessor :seed_brokers, :client_id, :connect_timeout, :socket_timeout,
+                    :ssl_ca_cert, :ssl_client_cert, :ssl_client_cert_key,
+                    :delivery_threshold, :delivery_interval,
+                    :topic, :partition, :partition_key, :key
 
-  # Send log messages to Kafka in JSON format.
-  #
-  # Kafka Parameters:
-  #
-  #   seed_brokers: [Array<String>, String]
-  #     The list of brokers used to initialize the client. Either an Array of connections,
-  #     or a comma separated string of connections.
-  #     Connections can either be a string of "port:protocol" or a full URI with a scheme.
-  #     If there's a scheme it's ignored and only host/port are used.
-  #
-  #   client_id: [String]
-  #     The identifier for this application.
-  #     Default: semantic-logger
-  #
-  #   topic: [String]
-  #     Topic to publish log messages to.
-  #     Default: 'log_messages'
-  #
-  #   partition: [Integer]
-  #     The partition that the message should be written to.
-  #     Default: nil
-  #
-  #   partition_key: [String]
-  #     The key that should be used to assign a partition.
-  #     Default: nil
-  #
-  #   key: [String]
-  #     The message key.
-  #     Default: nil
-  #
-  #   connect_timeout: [Integer]
-  #     The timeout setting for connecting to brokers.
-  #     Default: nil
-  #
-  #   socket_timeout: [Integer]
-  #     The timeout setting for socket connections.
-  #     Default: nil
-  #
-  #   ssl_ca_cert: [String, Array<String>]
-  #     A PEM encoded CA cert, or an Array of PEM encoded CA certs, to use with a SSL connection.
-  #     Default: nil
-  #
-  #   ssl_client_cert: [String]
-  #     A PEM encoded client cert to use with a SSL connection.
-  #     Must be used in combination with ssl_client_cert_key.
-  #     Default: nil
-  #
-  #   ssl_client_cert_key [String]
-  #     A PEM encoded client cert key to use with a SSL connection.
-  #     Must be used in combination with ssl_client_cert.
-  #     Default: nil
-  #
-  #    delivery_threshold: [Integer]
-  #      Number of messages between triggering a delivery of messages to Apache Kafka.
-  #      Default: 100
-  #
-  #    delivery_interval: [Integer]
-  #      Number of seconds between triggering a delivery of messages to Apache Kafka.
-  #      Default: 5
-  #
-  # Semantic Logger Parameters:
-  #
-  #   level: [:trace | :debug | :info | :warn | :error | :fatal]
-  #     Override the log level for this appender.
-  #     Default: SemanticLogger.default_level
-  #
-  #   formatter: [Object|Proc|Symbol|Hash]
-  #     An instance of a class that implements #call, or a Proc to be used to format
-  #     the output from this appender
-  #     Default: :raw_json (See: #call)
-  #
-  #   filter: [Regexp|Proc]
-  #     RegExp: Only include log messages where the class name matches the supplied.
-  #     regular expression. All other messages will be ignored.
-  #     Proc: Only include log messages where the supplied Proc returns true
-  #           The Proc must return true or false.
-  #
-  #   host: [String]
-  #     Name of this host to appear in log messages.
-  #     Default: SemanticLogger.host
-  #
-  #   application: [String]
-  #     Name of this application to appear in log messages.
-  #     Default: SemanticLogger.application
-  def initialize(seed_brokers:, client_id: 'semantic-logger', connect_timeout: nil, socket_timeout: nil,
-                 ssl_ca_cert: nil, ssl_client_cert: nil, ssl_client_cert_key: nil,
-                 topic: 'log_messages', partition: nil, partition_key: nil, key: nil,
-                 delivery_threshold: 100, delivery_interval: 10,
-                 level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
+      # Send log messages to Kafka in JSON format.
+      #
+      # Kafka Parameters:
+      #
+      #   seed_brokers: [Array<String>, String]
+      #     The list of brokers used to initialize the client. Either an Array of connections,
+      #     or a comma separated string of connections.
+      #     Connections can either be a string of "port:protocol" or a full URI with a scheme.
+      #     If there's a scheme it's ignored and only host/port are used.
+      #
+      #   client_id: [String]
+      #     The identifier for this application.
+      #     Default: semantic-logger
+      #
+      #   topic: [String]
+      #     Topic to publish log messages to.
+      #     Default: 'log_messages'
+      #
+      #   partition: [Integer]
+      #     The partition that the message should be written to.
+      #     Default: nil
+      #
+      #   partition_key: [String]
+      #     The key that should be used to assign a partition.
+      #     Default: nil
+      #
+      #   key: [String]
+      #     The message key.
+      #     Default: nil
+      #
+      #   connect_timeout: [Integer]
+      #     The timeout setting for connecting to brokers.
+      #     Default: nil
+      #
+      #   socket_timeout: [Integer]
+      #     The timeout setting for socket connections.
+      #     Default: nil
+      #
+      #   ssl_ca_cert: [String, Array<String>]
+      #     A PEM encoded CA cert, or an Array of PEM encoded CA certs, to use with a SSL connection.
+      #     Default: nil
+      #
+      #   ssl_client_cert: [String]
+      #     A PEM encoded client cert to use with a SSL connection.
+      #     Must be used in combination with ssl_client_cert_key.
+      #     Default: nil
+      #
+      #   ssl_client_cert_key [String]
+      #     A PEM encoded client cert key to use with a SSL connection.
+      #     Must be used in combination with ssl_client_cert.
+      #     Default: nil
+      #
+      #    delivery_threshold: [Integer]
+      #      Number of messages between triggering a delivery of messages to Apache Kafka.
+      #      Default: 100
+      #
+      #    delivery_interval: [Integer]
+      #      Number of seconds between triggering a delivery of messages to Apache Kafka.
+      #      Default: 5
+      #
+      # Semantic Logger Parameters:
+      #
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: SemanticLogger.default_level
+      #
+      #   formatter: [Object|Proc|Symbol|Hash]
+      #     An instance of a class that implements #call, or a Proc to be used to format
+      #     the output from this appender
+      #     Default: :raw_json (See: #call)
+      #
+      #   filter: [Regexp|Proc]
+      #     RegExp: Only include log messages where the class name matches the supplied.
+      #     regular expression. All other messages will be ignored.
+      #     Proc: Only include log messages where the supplied Proc returns true
+      #           The Proc must return true or false.
+      #
+      #   host: [String]
+      #     Name of this host to appear in log messages.
+      #     Default: SemanticLogger.host
+      #
+      #   application: [String]
+      #     Name of this application to appear in log messages.
+      #     Default: SemanticLogger.application
+      def initialize(seed_brokers:, client_id: 'semantic-logger', connect_timeout: nil, socket_timeout: nil,
+                     ssl_ca_cert: nil, ssl_client_cert: nil, ssl_client_cert_key: nil,
+                     topic: 'log_messages', partition: nil, partition_key: nil, key: nil,
+                     delivery_threshold: 100, delivery_interval: 10,
+                     level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
 
-    @seed_brokers        = seed_brokers
-    @client_id           = @client_id
-    @connect_timeout     = connect_timeout
-    @socket_timeout      = socket_timeout
-    @ssl_ca_cert         = ssl_ca_cert
-    @ssl_client_cert     = ssl_client_cert
-    @ssl_client_cert_key = ssl_client_cert_key
-    @topic               = topic
-    @partition           = partition
-    @partition_key       = partition_key
-    @key                 = key
-    @delivery_threshold  = delivery_threshold
-    @delivery_interval   = delivery_interval
+        @seed_brokers        = seed_brokers
+        @client_id           = client_id
+        @connect_timeout     = connect_timeout
+        @socket_timeout      = socket_timeout
+        @ssl_ca_cert         = ssl_ca_cert
+        @ssl_client_cert     = ssl_client_cert
+        @ssl_client_cert_key = ssl_client_cert_key
+        @topic               = topic
+        @partition           = partition
+        @partition_key       = partition_key
+        @key                 = key
+        @delivery_threshold  = delivery_threshold
+        @delivery_interval   = delivery_interval
 
-    super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
-    reopen
-  end
+        super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
+        reopen
+      end
 
-  def reopen
-    @kafka = ::Kafka.new(
-      seed_brokers:        seed_brokers,
-      client_id:           client_id,
-      connect_timeout:     connect_timeout,
-      socket_timeout:      socket_timeout,
-      ssl_ca_cert:         ssl_ca_cert,
-      ssl_client_cert:     ssl_client_cert,
-      ssl_client_cert_key: ssl_client_cert_key,
-      logger:              logger
-    )
+      def reopen
+        @kafka = ::Kafka.new(
+          seed_brokers:        seed_brokers,
+          client_id:           client_id,
+          connect_timeout:     connect_timeout,
+          socket_timeout:      socket_timeout,
+          ssl_ca_cert:         ssl_ca_cert,
+          ssl_client_cert:     ssl_client_cert,
+          ssl_client_cert_key: ssl_client_cert_key,
+          logger:              logger
+        )
 
-    @producer = @kafka.async_producer(
-      delivery_threshold: delivery_threshold,
-      delivery_interval:  delivery_interval
-    )
-  end
+        @producer = @kafka.async_producer(
+          delivery_threshold: delivery_threshold,
+          delivery_interval:  delivery_interval
+        )
+      end
 
-  def close
-    @producer.shutdown if @producer
-    @producer = nil
-    @kafka.close if @kafka
-    @kafka = nil
-  end
+      def close
+        @producer&.shutdown
+        @producer = nil
+        @kafka&.close
+        @kafka = nil
+      end
 
-  # Forward log messages to Kafka producer thread.
-  def log(log)
-    json = formatter.call(log, self)
-    @producer.produce(json, topic: topic, partition: partition, partition_key: partition_key, key: key)
-  end
+      # Forward log messages to Kafka producer thread.
+      def log(log)
+        json = formatter.call(log, self)
+        @producer.produce(json, topic: topic, partition: partition, partition_key: partition_key, key: key)
+      end
 
-  # Use JSON Formatter by default.
-  def default_formatter
-    SemanticLogger::Formatters::Json.new
-  end
+      # Use JSON Formatter by default.
+      def default_formatter
+        SemanticLogger::Formatters::Json.new
+      end
 
-  # Restart producer thread since there is no other way to flush.
-  def flush
-    @producer.shutdown
-    @producer = @kafka.async_producer(
-      delivery_threshold: delivery_threshold,
-      delivery_interval:  delivery_interval
-    )
+      # Restart producer thread since there is no other way to flush.
+      def flush
+        @producer.shutdown
+        @producer = @kafka.async_producer(
+          delivery_threshold: delivery_threshold,
+          delivery_interval:  delivery_interval
+        )
+      end
+    end
   end
-
 end