Module: SemanticLogger::Loggable::ClassMethods

Defined in:
lib/semantic_logger/loggable.rb

Instance Method Summary collapse

Instance Method Details

#logger_measure_method(method_name, min_duration: 0.0, metric: "#{name}/#{method_name}", log_exception: :partial, on_exception_level: nil, message: "##{method_name}", level: :info) ⇒ Object

Measure and log the performance of an instance method.

Parameters:

method_name: [Symbol]
  The name of the method that should be measured.

options: [Hash]
  Any valid options that can be passed to measure.

Approximate overhead when logging a method call with a metric:

0.044 ms  per method call.
0.009 ms  per method call. If `min_duration` is not met
0.0005 ms per method call. If `level` is not met



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/semantic_logger/loggable.rb', line 72

def logger_measure_method(method_name,
                          min_duration: 0.0,
                          metric: "#{name}/#{method_name}",
                          log_exception: :partial,
                          on_exception_level: nil,
                          message: "##{method_name}",
                          level: :info)

  # unless visibility = Utils.method_visibility(self, method_name)
  #   logger.warn("Unable to measure method: #{name}##{method_name} since it does not exist")
  #   return false
  # end

  index = SemanticLogger.level_to_index(level)

  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},
          min_duration:       #{min_duration},
          metric:             #{metric.inspect},
          log_exception:      #{log_exception.inspect},
          on_exception_level: #{on_exception_level.inspect}
        ) do
          super(*args, &block)
        end
      else
        super(*args, &block)
      end
    end
  MEASURE_METHOD
  # {"#{visibility} :#{method_name}" unless visibility == :public}
  true
end