semantic_logger 4.5.0 → 4.7.1

data/lib/semantic_logger/appender/elasticsearch_http.rb

@@ -1,4 +1,4 @@
-require 'date'
+require "date"
 # Forward all log messages to Elasticsearch one at a time via a HTTP post.
 #
 # Note:
@@ -50,9 +50,9 @@ module SemanticLogger
       #   application: [String]
       #     Name of this application to appear in log messages.
       #     Default: SemanticLogger.application
-      def initialize(index: 'semantic_logger',
-                     type: 'log',
-                     url: 'http://localhost:9200',
+      def initialize(index: "semantic_logger",
+                     type: "log",
+                     url: "http://localhost:9200",
                      **http_args,
                      &block)
 

data/lib/semantic_logger/appender/file.rb

@@ -64,7 +64,8 @@ module SemanticLogger
           @log = io
         else
           @file_name = file_name
-          raise 'SemanticLogging::Appender::File missing mandatory parameter :file_name or :io' unless file_name
+          raise "SemanticLogging::Appender::File missing mandatory parameter :file_name or :io" unless file_name
+
           reopen
         end
 

data/lib/semantic_logger/appender/graylog.rb

@@ -1,8 +1,8 @@
-require 'uri'
+require "uri"
 begin
-  require 'gelf'
+  require "gelf"
 rescue LoadError
-  raise 'Gem gelf is required for logging to Graylog. Please add the gem "gelf" to your Gemfile.'
+  raise LoadError, 'Gem gelf is required for logging to Graylog. Please add the gem "gelf" to your Gemfile.'
 end
 
 # Forward log entries to a Graylog server.
@@ -82,8 +82,8 @@ module SemanticLogger
       #   application: [String]
       #     Name of this application to appear in log messages.
       #     Default: SemanticLogger.application
-      def initialize(url: 'udp://localhost:12201',
-                     max_size: 'WAN',
+      def initialize(url: "udp://localhost:12201",
+                     max_size: "WAN",
                      gelf_options: {},
                      level_map: LevelMap.new,
                      **args,
@@ -105,7 +105,9 @@ module SemanticLogger
         @port     = uri.port
         @protocol = uri.scheme.to_sym
 
-        raise(ArgumentError, "Invalid protocol value: #{@protocol}. Must be :udp or :tcp") unless %i[udp tcp].include?(@protocol)
+        unless %i[udp tcp].include?(@protocol)
+          raise(ArgumentError, "Invalid protocol value: #{@protocol}. Must be :udp or :tcp")
+        end
 
         gelf_options[:protocol] ||= (@protocol == :tcp ? GELF::Protocol::TCP : GELF::Protocol::UDP)
         gelf_options[:facility] ||= application
@@ -118,10 +120,13 @@ module SemanticLogger
       def call(log, logger)
         h = default_formatter.call(log, logger)
 
-        h[:short_message] = h.delete(:message) || log.exception.message
-        h[:level]         = logger.level_map[log.level]
-        h[:level_str]     = log.level.to_s
-        h[:duration_str]  = h.delete(:duration)
+        h[:short_message] = h.delete(:message)
+        if h[:short_message].nil?
+          h[:short_message] = log.exception.nil? ? "<no-exception-message>" : log.exception.message
+        end
+        h[:level]        = logger.level_map[log.level]
+        h[:level_str]    = log.level.to_s
+        h[:duration_str] = h.delete(:duration)
         h
       end
 

data/lib/semantic_logger/appender/honeybadger.rb

@@ -1,7 +1,7 @@
 begin
-  require 'honeybadger'
+  require "honeybadger"
 rescue LoadError
-  raise 'Gem honeybadger is required for logging purposes. Please add the gem "honeybadger" to your Gemfile.'
+  raise LoadError, 'Gem honeybadger is required for logging purposes. Please add the gem "honeybadger" to your Gemfile.'
 end
 
 # Send log messages to honeybadger
@@ -48,7 +48,7 @@ module SemanticLogger
           context.delete(:exception)
           ::Honeybadger.notify(log.exception, context)
         else
-          message             = {
+          message = {
             error_class:   context.delete(:name),
             error_message: context.delete(:message),
             context:       context

data/lib/semantic_logger/appender/http.rb

@@ -1,8 +1,8 @@
-require 'net/http'
-require 'uri'
-require 'socket'
-require 'json'
-require 'openssl'
+require "net/http"
+require "uri"
+require "socket"
+require "json"
+require "openssl"
 
 # Log to any HTTP(S) server that accepts log messages in JSON form
 #
@@ -101,27 +101,29 @@ module SemanticLogger
         @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 = {
+          "Accept"       => "application/json",
+          "Content-Type" => "application/json",
+          "Connection"   => "keep-alive",
+          "Keep-Alive"   => "300"
         }
-        @header['Content-Encoding'] = 'gzip' if @compress
+        @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
+        unless @server
+          raise(ArgumentError, "Invalid format for :url: #{@url.inspect}. Should be similar to: 'http://hostname:port/path'")
+        end
 
         @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 == ''
+        @path     = "/" if @path == ""
 
-        if uri.scheme == 'https'
-          @ssl_options[:use_ssl]     = true
+        if uri.scheme == "https"
+          @ssl_options[:use_ssl] = true
           @ssl_options[:verify_mode] ||= OpenSSL::SSL::VERIFY_PEER
           @port                      ||= HTTP.https_default_port
         else
@@ -205,16 +207,16 @@ module SemanticLogger
         end
         request.basic_auth(@username, @password) if @username
         response = @http.request(request)
-        if response.code == '200' || response.code == '201'
+        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
+      rescue RuntimeError => e
         reopen
-        raise exc
+        raise e
       end
     end
   end

data/lib/semantic_logger/appender/kafka.rb

@@ -1,10 +1,10 @@
 begin
-  require 'kafka'
+  require "kafka"
 rescue LoadError
-  raise 'Gem ruby-kafka is required for logging to Elasticsearch. Please add the gem "ruby-kafka" to your Gemfile.'
+  raise LoadError, 'Gem ruby-kafka is required for logging to Elasticsearch. Please add the gem "ruby-kafka" to your Gemfile.'
 end
 
-require 'date'
+require "date"
 
 # Forward all log messages to Apache Kafka.
 #
@@ -115,9 +115,9 @@ module SemanticLogger
       #   metrics: [Boolean]
       #     Send metrics only events to kafka.
       #     Default: true
-      def initialize(seed_brokers:, client_id: 'semantic-logger', connect_timeout: nil, socket_timeout: nil,
+      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,
+                     topic: "log_messages", partition: nil, partition_key: nil, key: nil,
                      delivery_threshold: 100, delivery_interval: 10,
                      metrics: true, **args, &block)
 

data/lib/semantic_logger/appender/mongodb.rb

@@ -1,8 +1,8 @@
-require 'socket'
+require "socket"
 begin
-  require 'mongo'
+  require "mongo"
 rescue LoadError
-  raise 'Gem mongo is required for logging to MongoDB. Please add the gem "mongo" v2.0 or greater to your Gemfile.'
+  raise LoadError, 'Gem mongo is required for logging to MongoDB. Please add the gem "mongo" v2.0 or greater to your Gemfile.'
 end
 
 module SemanticLogger
@@ -104,9 +104,9 @@ module SemanticLogger
       #     Name of this application to appear in log messages.
       #     Default: SemanticLogger.application
       def initialize(uri:,
-                     collection_name: 'semantic_logger',
+                     collection_name: "semantic_logger",
                      write_concern: 0,
-                     collection_size: 1024 ** 3,
+                     collection_size: 1024**3,
                      collection_max: nil,
                      **args,
                      &block)
@@ -118,7 +118,7 @@ module SemanticLogger
           size:   collection_size,
           write:  {w: write_concern}
         }
-        @options[:max]   = collection_max if collection_max
+        @options[:max] = collection_max if collection_max
 
         reopen
 

data/lib/semantic_logger/appender/new_relic.rb

@@ -1,7 +1,7 @@
 begin
-  require 'newrelic_rpm'
+  require "newrelic_rpm"
 rescue LoadError
-  raise 'Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.'
+  raise LoadError, 'Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.'
 end
 
 # Send log messages to NewRelic

data/lib/semantic_logger/appender/rabbitmq.rb

@@ -1,7 +1,7 @@
 begin
-  require 'bunny'
+  require "bunny"
 rescue LoadError
-  raise 'Gem bunny is required for logging to RabbitMQ. Please add the gem "bunny" to your Gemfile.'
+  raise LoadError, 'Gem bunny is required for logging to RabbitMQ. Please add the gem "bunny" to your Gemfile.'
 end
 
 # Forward all log messages to RabbitMQ.
@@ -14,7 +14,7 @@ end
 #     # Name of the queue in RabbitMQ where to publish the logs. This queue will be bound to "amqp.direct" exchange.
 #     queue: 'semantic_logger',
 #
-#     # This host will be used for RabbitMQ connection. 
+#     # This host will be used for RabbitMQ connection.
 #     # NOTE this is different than :host option which is used by the logger directly.
 #     rabbitmq_host: '127.0.0.1',
 #
@@ -63,7 +63,7 @@ module SemanticLogger
       # RabbitMQ Parameters:
       #
       #   rabbitmq_host: [String]
-      #     Host for AMQP connection. in Bunny this is called :host but here it has 
+      #     Host for AMQP connection. in Bunny this is called :host but here it has
       #     been remapped to avoid conflicting with SemanticLogger's :host param.
       #     Default: localhost
       #
@@ -76,7 +76,7 @@ module SemanticLogger
       #     Default: nil
       #
       #   more parameters supported by Bunny: http://rubybunny.info/articles/connecting.html
-      def initialize(queue_name: 'semantic_logger', rabbitmq_host: nil, metrics: false, **args, &block)
+      def initialize(queue_name: "semantic_logger", rabbitmq_host: nil, metrics: false, **args, &block)
         @queue_name             = queue_name
         @rabbitmq_args          = args.dup
         @rabbitmq_args[:host]   = rabbitmq_host

data/lib/semantic_logger/appender/sentry.rb

@@ -1,7 +1,7 @@
 begin
-  require 'sentry-raven'
+  require "sentry-raven"
 rescue LoadError
-  raise 'Gem sentry-raven is required for logging purposes. Please add the gem "sentry-raven" to your Gemfile.'
+  raise LoadError, 'Gem sentry-raven is required for logging purposes. Please add the gem "sentry-raven" to your Gemfile.'
 end
 
 # Send log messages to sentry
@@ -46,12 +46,12 @@ module SemanticLogger
       # Send an error notification to sentry
       def log(log)
         # Ignore logs coming from Raven itself
-        return false if log.name == 'Raven'
+        return false if log.name == "Raven"
 
-        context = formatter.call(log, self)
-        user = context.delete(:user)
-        tags = context.delete(:tags)
-        attrs = {
+        context      = formatter.call(log, self)
+        user         = context.delete(:user)
+        tags         = context.delete(:tags)
+        attrs        = {
           level: context.delete(:level),
           extra: context
         }

data/lib/semantic_logger/appender/splunk.rb

@@ -1,7 +1,7 @@
 begin
-  require 'splunk-sdk-ruby'
+  require "splunk-sdk-ruby"
 rescue LoadError
-  raise 'Gem splunk-sdk-ruby is required for logging to Splunk. Please add the gem "splunk-sdk-ruby" to your Gemfile.'
+  raise LoadError, 'Gem splunk-sdk-ruby is required for logging to Splunk. Please add the gem "splunk-sdk-ruby" to your Gemfile.'
 end
 
 # Splunk log appender.
@@ -88,7 +88,7 @@ module SemanticLogger
       #     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.
-      def initialize(index: 'main', source_type: nil, **args, &block)
+      def initialize(index: "main", source_type: nil, **args, &block)
         @index       = index
         @source_type = source_type
 
@@ -120,14 +120,15 @@ module SemanticLogger
       def call(log, logger)
         h = SemanticLogger::Formatters::Raw.new.call(log, logger)
         h.delete(:time)
-        message               = {
+        message = {
           source:  logger.application,
           host:    logger.host,
           time:    log.time.utc.to_f,
           message: h.delete(:message),
           event:   h
         }
-        message[:sourcetype] = source_type if source_type
+        message[:environment] = logger.environment if logger.environment
+        message[:sourcetype]  = source_type if source_type
         message
       end
     end

data/lib/semantic_logger/appender/splunk_http.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 # Splunk log appender using the Splunk HTTP(S) listener.
 #
 # Use the newer, faster and more complete JSON over HTTP interface for Splunk.
@@ -81,13 +81,13 @@ module SemanticLogger
         super(compress: compress, **args, &block)
 
         # Put splunk auth token in the header of every HTTP post.
-        @header['Authorization'] = "Splunk #{token}"
+        @header["Authorization"] = "Splunk #{token}"
       end
 
       # Returns [String] JSON to send to Splunk.
       #
       # For splunk format requirements see:
-      #   http://dev.splunk.com/view/event-collector/SP-CAAAE6P
+      #   https://docs.splunk.com/Documentation/Splunk/latest/Data/FormateventsforHTTPEventCollector
       def call(log, logger)
         h                     = SemanticLogger::Formatters::Raw.new(time_format: :seconds).call(log, logger)
         message               = {

data/lib/semantic_logger/appender/syslog.rb

@@ -1,6 +1,6 @@
-require 'syslog'
-require 'uri'
-require 'socket'
+require "syslog"
+require "uri"
+require "socket"
 # Send log messages to local syslog, or remote syslog servers over TCP or UDP.
 #
 # Example:
@@ -119,7 +119,7 @@ module SemanticLogger
       #   Example:
       #     # Change the warn level to LOG_NOTICE level instead of a the default of LOG_WARNING.
       #     SemanticLogger.add_appender(appender: :syslog, level_map: {warn: ::Syslog::LOG_NOTICE})
-      def initialize(url: 'syslog://localhost',
+      def initialize(url: "syslog://localhost",
                      facility: ::Syslog::LOG_USER,
                      level_map: SemanticLogger::Formatters::Syslog::LevelMap.new,
                      options: ::Syslog::LOG_PID | ::Syslog::LOG_CONS,
@@ -132,10 +132,10 @@ module SemanticLogger
         @level_map          = level_map
         @url                = url
         uri                 = URI(@url)
-        @server             = uri.host || 'localhost'
+        @server             = uri.host || "localhost"
         @protocol           = (uri.scheme || :syslog).to_sym
         @port               = uri.port || 514
-        @server             = 'localhost' if @protocol == :syslog
+        @server             = "localhost" if @protocol == :syslog
         @tcp_client_options = tcp_client
 
         raise "Unknown protocol #{@protocol}!" unless %i[syslog tcp udp].include?(@protocol)
@@ -143,17 +143,17 @@ module SemanticLogger
         # The syslog_protocol gem is required when logging over TCP or UDP.
         if %i[tcp udp].include?(@protocol)
           begin
-            require 'syslog_protocol'
+            require "syslog_protocol"
           rescue LoadError
-            raise 'Missing gem: syslog_protocol. This gem is required when logging over TCP or UDP. To fix this error: gem install syslog_protocol'
+            raise LoadError, "Missing gem: syslog_protocol. This gem is required when logging over TCP or UDP. To fix this error: gem install syslog_protocol"
           end
 
           # The net_tcp_client gem is required when logging over TCP.
           if protocol == :tcp
             begin
-              require 'net/tcp_client'
+              require "net/tcp_client"
             rescue LoadError
-              raise 'Missing gem: net_tcp_client. This gem is required when logging over TCP. To fix this error: gem install net_tcp_client'
+              raise LoadError, "Missing gem: net_tcp_client. This gem is required when logging over TCP. To fix this error: gem install net_tcp_client"
             end
           end
         end
@@ -171,7 +171,7 @@ module SemanticLogger
           ::Syslog.send(method, application, options, facility)
         when :tcp
           @tcp_client_options[:server] = "#{@server}:#{@port}"
-          @remote_syslog               = Net::TCPClient.new(@tcp_client_options)
+          @remote_syslog               = Net::TCPClient.new(**@tcp_client_options)
           # Use the local logger for @remote_syslog so errors with the remote logger can be recorded locally.
           @remote_syslog.logger = logger
         when :udp
@@ -186,7 +186,7 @@ module SemanticLogger
         case @protocol
         when :syslog
           # Since the Ruby Syslog API supports sprintf format strings, double up all existing '%'
-          message = formatter.call(log, self).gsub '%', '%%'
+          message = formatter.call(log, self).gsub "%", "%%"
           ::Syslog.log @level_map[log.level], message
         when :tcp
           @remote_syslog.retry_on_connection_failure { @remote_syslog.write("#{formatter.call(log, self)}\r\n") }

data/lib/semantic_logger/appender/tcp.rb

@@ -1,10 +1,10 @@
 begin
-  require 'net/tcp_client'
+  require "net/tcp_client"
 rescue LoadError
-  raise 'Gem net_tcp_client is required for logging over TCP. Please add the gem "net_tcp_client" to your Gemfile.'
+  raise LoadError, 'Gem net_tcp_client is required for logging over TCP. Please add the gem "net_tcp_client" to your Gemfile.'
 end
 
-raise 'Net::TCPClient v2.0 or greater is required to log over TCP' unless Net::TCPClient::VERSION.to_f >= 2.0
+raise "Net::TCPClient v2.0 or greater is required to log over TCP" unless Net::TCPClient::VERSION.to_f >= 2.0
 
 module SemanticLogger
   module Appender
@@ -89,7 +89,7 @@ module SemanticLogger
       #     where multiple sends are expected during a single response
       #     Default: true
       #
-      #   :connect_retry_count [Fixnum]
+      #   :connect_retry_count [Integer]
       #     Number of times to retry connecting when a connection fails
       #     Default: 10
       #
@@ -97,7 +97,7 @@ module SemanticLogger
       #     Number of seconds between connection retry attempts after the first failed attempt
       #     Default: 0.5
       #
-      #   :retry_count [Fixnum]
+      #   :retry_count [Integer]
       #     Number of times to retry when calling #retry_on_connection_failure
       #     This is independent of :connect_retry_count which still applies with
       #     connection failures. This retry controls upto how many times to retry the
@@ -182,23 +182,23 @@ module SemanticLogger
       #     connect_retry_count:    5
       #   )
       def initialize(separator: "\n",
-                     level: nil, formatter: nil, filter: nil, application: nil, host: nil, metrics: false,
+                     level: nil, formatter: nil, filter: nil, application: nil, environment: nil, host: nil, metrics: false,
                      **tcp_client_args, &block)
         @separator       = separator
         @tcp_client_args = tcp_client_args
 
         # Use the internal logger so that errors with remote logging are only written locally.
         Net::TCPClient.logger      = logger
-        Net::TCPClient.logger.name = 'Net::TCPClient'
+        Net::TCPClient.logger.name = "Net::TCPClient"
 
-        super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
+        super(level: level, formatter: formatter, filter: filter, application: application, environment: environment, host: host, &block)
         reopen
       end
 
       # After forking an active process call #reopen to re-open the handles to resources.
       def reopen
         close
-        @tcp_client = Net::TCPClient.new(@tcp_client_args)
+        @tcp_client = Net::TCPClient.new(**@tcp_client_args)
       end
 
       # Write the log using the specified protocol and server.