semantic_logger 4.2.0 → 4.2.1

data/lib/semantic_logger/loggable.rb

@@ -30,7 +30,6 @@
 #     ExternalSupplier.prepend SemanticLogger::Loggable
 module SemanticLogger
   module Loggable
-
     def self.included(base)
       base.extend ClassMethods
       base.class_eval do
@@ -85,14 +84,14 @@ module SemanticLogger
 
         index = SemanticLogger.level_to_index(level)
 
-        logger_measure_module.module_eval(<<-EOT, __FILE__, __LINE__ + 1)
+        logger_measure_module.module_eval(<<~MEASURE_METHOD, __FILE__, __LINE__ + 1)
           def #{method_name}(*args, &block)
             if logger.send(:level_index) <= #{index}
               logger.send(
                 :measure_method,
-                index:              #{index}, 
-                level:              #{level.inspect}, 
-                message:            #{message.inspect}, 
+                index:              #{index},
+                level:              #{level.inspect},
+                message:            #{message.inspect},
                 min_duration:       #{min_duration},
                 metric:             #{metric.inspect},
                 log_exception:      #{log_exception.inspect},
@@ -104,8 +103,8 @@ module SemanticLogger
               super(*args, &block)
             end
           end
-        EOT
-        #{"#{visibility} :#{method_name}" unless visibility == :public}
+        MEASURE_METHOD
+        # {"#{visibility} :#{method_name}" unless visibility == :public}
         true
       end
 
@@ -121,8 +120,6 @@ module SemanticLogger
           mod
         end
       end
-
     end
-
   end
 end

data/lib/semantic_logger/logger.rb

@@ -37,6 +37,5 @@ module SemanticLogger
       return add(log, message, progname, &block) unless log.is_a?(SemanticLogger::Log)
       Processor << log
     end
-
   end
 end

data/lib/semantic_logger/metric/new_relic.rb

@@ -11,65 +11,68 @@ end
 #
 # Example:
 #   SemanticLogger.add_appender(metric: :new_relic)
-class SemanticLogger::Metric::NewRelic < SemanticLogger::Subscriber
-  attr_accessor :prefix
+module SemanticLogger
+  module Metric
+    class NewRelic < SemanticLogger::Subscriber
+      attr_accessor :prefix
 
-  # Create Appender
-  #
-  # Parameters
-  #   :prefix [String]
-  #     Prefix to add to every metric before forwarding to NewRelic.
-  #     Default: 'Custom'
-  #
-  #   level: [:trace | :debug | :info | :warn | :error | :fatal]
-  #     Override the log level for this appender.
-  #     Default: :error
-  #
-  #   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.
-  def initialize(prefix: 'Custom',
-                 level: nil,
-                 formatter: nil,
-                 filter: nil,
-                 application: nil,
-                 host: nil,
-                 &block)
+      # Create Appender
+      #
+      # Parameters
+      #   :prefix [String]
+      #     Prefix to add to every metric before forwarding to NewRelic.
+      #     Default: 'Custom'
+      #
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: :error
+      #
+      #   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.
+      def initialize(prefix: 'Custom',
+                     level: nil,
+                     formatter: nil,
+                     filter: nil,
+                     application: nil,
+                     host: nil,
+                     &block)
 
-    @prefix = prefix
-    super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
-  end
+        @prefix = prefix
+        super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
+      end
 
-  # Returns metric name to use.
-  def call(log, _logger)
-    metric = log.metric
-    # Add prefix for NewRelic
-    metric = "#{prefix}/#{metric}" unless metric.start_with?(prefix)
-    metric
-  end
+      # Returns metric name to use.
+      def call(log, _logger)
+        metric = log.metric
+        # Add prefix for NewRelic
+        metric = "#{prefix}/#{metric}" unless metric.start_with?(prefix)
+        metric
+      end
 
-  def log(log)
-    name = formatter.call(log, self)
-    if duration = log.duration
-      # Convert duration to seconds
-      ::NewRelic::Agent.record_metric(name, duration / 1000.0)
-    else
-      ::NewRelic::Agent.increment_metric(name, log.metric_amount || 1)
-    end
-    true
-  end
+      def log(log)
+        name = formatter.call(log, self)
+        if (duration = log.duration)
+          # Convert duration to seconds
+          ::NewRelic::Agent.record_metric(name, duration / 1000.0)
+        else
+          ::NewRelic::Agent.increment_metric(name, log.metric_amount || 1)
+        end
+        true
+      end
 
-  # Only forward log entries that contain metrics.
-  def should_log?(log)
-    # Does not support metrics with dimensions.
-    log.metric && !log.dimensions && meets_log_level?(log) && !filtered?(log)
+      # Only forward log entries that contain metrics.
+      def should_log?(log)
+        # Does not support metrics with dimensions.
+        log.metric && !log.dimensions && meets_log_level?(log) && !filtered?(log)
+      end
+    end
   end
-
 end

data/lib/semantic_logger/metric/signalfx.rb

@@ -5,119 +5,121 @@
 #     metric: :signalfx,
 #     token:  'SIGNALFX_ORG_ACCESS_TOKEN'
 #   )
-class SemanticLogger::Metric::Signalfx < SemanticLogger::Appender::Http
-  attr_reader :full_url
+module SemanticLogger
+  module Metric
+    class Signalfx < SemanticLogger::Appender::Http
+      attr_reader :full_url
 
-  END_POINT = 'v2/datapoint'
+      END_POINT = 'v2/datapoint'.freeze
 
-  # Create SignalFx metrics appender.
-  #
-  # Parameters:
-  #   token: [String]
-  #     Access Token to use for sending metrics.
-  #     Obtain the Signalfx token via the Signalfx Web UI under `Organization` -> `Access Tokens`.
-  #
-  #   dimensions: [Array<String>]
-  #     Dimensions to forward to signalfx when they are present in the named tags of any log message.
-  #     By default `application` and `host` are always included as dimensions in all forwarded metrics.
-  #     Example: [:user_id, :state]
-  #
-  #   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 send as a dimension.
-  #     Default: SemanticLogger.host
-  #
-  #   application: [String]
-  #     Name of this application to send as a dimension.
-  #     Default: SemanticLogger.application
-  #
-  #   url: [String]
-  #     Override the SignalFx service url.
-  #     For historical data use: https://backfill.signalfx.com/v1/backfill
-  #     Default: https://ingest.signalfx.com
-  #
-  # Notes:
-  #
-  # When sending a metric to Signalfx, it is necessary to send both a `gauge` and a `counter` when a
-  # duration is included in the metric, otherwise it is not possible to chart counts of the metric.
-  # Unfortunately this doubles the number of metrics, but it is the way Signalfx works.
-  # Using a `count` of a `gauge` in a chart will significantly under-count the number of occurrences.
-  #
-  # If dimensions are added to the metric, then the metric will be sent as-is and
-  # the above logic will _not_ be applied.
-  #
-  # Example, Gauge metric, supplying the duration in `metric_amount`:
-  #   logger.info(metric: 'Filters.average', metric_amount: 1.2, dimensions: {user: 'jbloggs'})
-  #
-  # Example, Counter metric:
-  #   logger.info(metric: 'Filters.count', dimensions: {user: 'jbloggs'})
-  #
-  # Example, Counter metric with a count other than 1:
-  #   logger.info(metric: 'Filters.count', metric_amount: 23, dimensions: {user: 'jbloggs'})
-  #
-  # When a duration is supplied and no dimensions are supplied:
-  #   logger.info(metric: 'Common/User/authorize', duration: 1.4)
-  #
-  # Then it is translated into the following 2 log entries under the covers:
-  #   logger.info(metric: 'Application.average', metric_amount: 1.4, dimensions: {class: 'Common::User', action: 'authorize'})
-  #   logger.info(metric: 'Application.counter', metric_amount: 1, dimensions: {class: 'Common::User', action: 'authorize'})
-  #
-  # Similarly with a measure block which automatically supplies the duration:
-  #   logger.measure_info(metric: 'Common/User/authorize') do
-  #     sleep 1
-  #   end
-  def initialize(token:,
-                 dimensions: nil,
-                 url: 'https://ingest.signalfx.com',
-                 open_timeout: 2.0,
-                 read_timeout: 1.0,
-                 continue_timeout: 1.0,
-                 filter: nil,
-                 application: nil,
-                 host: nil,
-                 formatter: nil,
-                 &block)
+      # Create SignalFx metrics appender.
+      #
+      # Parameters:
+      #   token: [String]
+      #     Access Token to use for sending metrics.
+      #     Obtain the Signalfx token via the Signalfx Web UI under `Organization` -> `Access Tokens`.
+      #
+      #   dimensions: [Array<String>]
+      #     Dimensions to forward to signalfx when they are present in the named tags of any log message.
+      #     By default `application` and `host` are always included as dimensions in all forwarded metrics.
+      #     Example: [:user_id, :state]
+      #
+      #   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 send as a dimension.
+      #     Default: SemanticLogger.host
+      #
+      #   application: [String]
+      #     Name of this application to send as a dimension.
+      #     Default: SemanticLogger.application
+      #
+      #   url: [String]
+      #     Override the SignalFx service url.
+      #     For historical data use: https://backfill.signalfx.com/v1/backfill
+      #     Default: https://ingest.signalfx.com
+      #
+      # Notes:
+      #
+      # When sending a metric to Signalfx, it is necessary to send both a `gauge` and a `counter` when a
+      # duration is included in the metric, otherwise it is not possible to chart counts of the metric.
+      # Unfortunately this doubles the number of metrics, but it is the way Signalfx works.
+      # Using a `count` of a `gauge` in a chart will significantly under-count the number of occurrences.
+      #
+      # If dimensions are added to the metric, then the metric will be sent as-is and
+      # the above logic will _not_ be applied.
+      #
+      # Example, Gauge metric, supplying the duration in `metric_amount`:
+      #   logger.info(metric: 'Filters.average', metric_amount: 1.2, dimensions: {user: 'jbloggs'})
+      #
+      # Example, Counter metric:
+      #   logger.info(metric: 'Filters.count', dimensions: {user: 'jbloggs'})
+      #
+      # Example, Counter metric with a count other than 1:
+      #   logger.info(metric: 'Filters.count', metric_amount: 23, dimensions: {user: 'jbloggs'})
+      #
+      # When a duration is supplied and no dimensions are supplied:
+      #   logger.info(metric: 'Common/User/authorize', duration: 1.4)
+      #
+      # Then it is translated into the following 2 log entries under the covers:
+      #   logger.info(metric: 'Application.average', metric_amount: 1.4, dimensions: {class: 'Common::User', action: 'authorize'})
+      #   logger.info(metric: 'Application.counter', metric_amount: 1, dimensions: {class: 'Common::User', action: 'authorize'})
+      #
+      # Similarly with a measure block which automatically supplies the duration:
+      #   logger.measure_info(metric: 'Common/User/authorize') do
+      #     sleep 1
+      #   end
+      def initialize(token:,
+                     dimensions: nil,
+                     url: 'https://ingest.signalfx.com',
+                     open_timeout: 2.0,
+                     read_timeout: 1.0,
+                     continue_timeout: 1.0,
+                     filter: nil,
+                     application: nil,
+                     host: nil,
+                     formatter: nil,
+                     &block)
 
-    formatter ||= SemanticLogger::Formatters::Signalfx.new(token: token, dimensions: dimensions)
+        formatter ||= SemanticLogger::Formatters::Signalfx.new(token: token, dimensions: dimensions)
 
-    super(
-      url:              url,
-      read_timeout:     read_timeout,
-      open_timeout:     open_timeout,
-      continue_timeout: continue_timeout,
-      filter:           filter,
-      application:      application,
-      host:             host,
-      formatter:        formatter,
-      &block
-    )
+        super(
+          url:              url,
+          read_timeout:     read_timeout,
+          open_timeout:     open_timeout,
+          continue_timeout: continue_timeout,
+          filter:           filter,
+          application:      application,
+          host:             host,
+          formatter:        formatter,
+          &block
+        )
 
-    @header['X-SF-TOKEN'] = token
-    @full_url             = "#{url}/#{END_POINT}"
-  end
+        @header['X-SF-TOKEN'] = token
+        @full_url             = "#{url}/#{END_POINT}"
+      end
 
-  def log(log)
-    message = formatter.call(log, self)
-    logger.trace(message)
-    post(message, full_url)
-  end
+      def log(log)
+        message = formatter.call(log, self)
+        logger.trace(message)
+        post(message, full_url)
+      end
 
-  # Logs in batches
-  def batch(logs)
-    message = formatter.batch(logs, self)
-    logger.trace(message)
-    post(message, full_url)
-  end
+      # Logs in batches
+      def batch(logs)
+        message = formatter.batch(logs, self)
+        logger.trace(message)
+        post(message, full_url)
+      end
 
-  # Only forward log entries that contain metrics.
-  def should_log?(log)
-    log.metric && meets_log_level?(log) && !filtered?(log)
+      # Only forward log entries that contain metrics.
+      def should_log?(log)
+        log.metric && meets_log_level?(log) && !filtered?(log)
+      end
+    end
   end
-
 end
-

data/lib/semantic_logger/metric/statsd.rb

@@ -41,11 +41,11 @@ module SemanticLogger
 
       def log(log)
         metric = log.metric
-        if duration = log.duration
+        if (duration = log.duration)
           @statsd.timing(metric, duration)
         else
           amount = (log.metric_amount || 1).round
-          if amount < 0
+          if amount.negative?
             amount.times { @statsd.decrement(metric) }
           else
             amount.times { @statsd.increment(metric) }
@@ -58,7 +58,6 @@ module SemanticLogger
         # Does not support metrics with dimensions.
         log.metric && !log.dimensions && meets_log_level?(log) && !filtered?(log)
       end
-
     end
   end
 end

data/lib/semantic_logger/processor.rb

@@ -60,8 +60,8 @@ module SemanticLogger
     #   Can be replaced with another Ruby logger or Rails logger, but never to
     #   SemanticLogger::Logger itself since it is for reporting problems
     #   while trying to log to the various appenders
-    def self.logger=(logger)
-      @logger = logger
+    class << self
+      attr_writer :logger
     end
 
     # Internal logger for SemanticLogger
@@ -86,7 +86,10 @@ module SemanticLogger
     def on_log(object = nil, &block)
       subscriber = block || object
 
-      raise('When supplying an on_log subscriber, it must support the #call method') unless subscriber.is_a?(Proc) || subscriber.respond_to?(:call)
+      unless subscriber.is_a?(Proc) || subscriber.respond_to?(:call)
+        raise('When supplying an on_log subscriber, it must support the #call method')
+      end
+
       subscribers = (@log_subscribers ||= Concurrent::Array.new)
       subscribers << subscriber unless subscribers.include?(subscriber)
     end
@@ -130,13 +133,11 @@ module SemanticLogger
     private
 
     def self.create_instance
-      SemanticLogger::Appender::Async.new(
-        name:           'SemanticLogger::Processor',
-        appender:       new,
-        max_queue_size: -1
-      )
+      SemanticLogger::Appender::Async.new(appender: new, max_queue_size: -1)
     end
 
+    private_class_method :create_instance
+
     @processor = create_instance
 
     # Call on_log subscribers
@@ -152,6 +153,5 @@ module SemanticLogger
         end
       end
     end
-
   end
 end