class OneApm::Logger::AgentLogger
Constants
- OA_LOG_LEVELS
- OA_NUM_LOG_ONCE_KEYS
Attributes
already_logged[R]
Public Class Methods
log_level_for(level)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 179 def self.log_level_for(level) OA_LOG_LEVELS.fetch(level.to_s.downcase, ::Logger::INFO) end
new(root = "", override_logger=nil)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 13 def initialize(root = "", override_logger=nil) clear_already_logged create_log(root, override_logger) set_log_level! set_log_format! gather_startup_logs end
Public Instance Methods
backtrace_from_exception(e)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 87 def backtrace_from_exception(e) # We've seen that often the backtrace on a SystemStackError is bunk # so massage the caller instead at a known depth. # # Tests keep us honest about minmum method depth our log calls add. return caller.drop(5) if e.is_a?(SystemStackError) e.backtrace end
clear_already_logged()
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 149 def clear_already_logged @already_logged = {} end
create_log(root, override_logger)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 115 def create_log(root, override_logger) if !override_logger.nil? @log = override_logger elsif OneApm::Manager.config[:agent_enabled] == false create_null_logger else if wants_stdout? @log = ::Logger.new(STDOUT) else create_log_to_file(root) end end end
create_log_to_file(root)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 129 def create_log_to_file(root) path = find_or_create_file_path(OneApm::Manager.config[:log_file_path], root) if path.nil? @log = ::Logger.new(STDOUT) warn("Error creating log directory #{OneApm::Manager.config[:log_file_path]}, using standard out for logging.") else file_path = "#{path}/#{OneApm::Manager.config[:log_file_name]}" begin @log = ::Logger.new(file_path) rescue => e @log = ::Logger.new(STDOUT) warn("Failed creating logger for file #{file_path}, using standard out for logging.", e) end end end
create_null_logger()
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 145 def create_null_logger @log = ::OneApm::Logger::NullLogger.new end
debug(*msgs, &blk)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 38 def debug(*msgs, &blk) format_and_send(:debug, msgs, &blk) end
error(*msgs, &blk)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 26 def error(*msgs, &blk) format_and_send(:error, msgs, &blk) end
fatal(*msgs, &blk)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 22 def fatal(*msgs, &blk) format_and_send(:fatal, msgs, &blk) end
find_or_create_file_path(path_setting, root)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 157 def find_or_create_file_path(path_setting, root) for abs_path in [ File.expand_path(path_setting), File.expand_path(File.join(root, path_setting)) ] do if File.directory?(abs_path) || (Dir.mkdir(abs_path) rescue nil) return abs_path[%r{^(.*?)/?$}] end end nil end def set_log_level! @log.level = AgentLogger.log_level_for(OneApm::Manager.config[:log_level]) end OA_LOG_LEVELS = { "debug" => ::Logger::DEBUG, "info" => ::Logger::INFO, "warn" => ::Logger::WARN, "error" => ::Logger::ERROR, "fatal" => ::Logger::FATAL, } def self.log_level_for(level) OA_LOG_LEVELS.fetch(level.to_s.downcase, ::Logger::INFO) end def set_log_format! @hostname = OneApm::Agent::Hostname.get @prefix = wants_stdout? ? '** [OneApm]' : '' @log.formatter = Proc.new do |severity, timestamp, progname, msg| "#{@prefix}[#{timestamp.strftime("%m/%d/%y %H:%M:%S %z")} #{@hostname} (#{$$})] #{severity} : #{msg}\n" end end def gather_startup_logs StartupLogger.instance.dump(self) end def log_formatter=(formatter) @log.formatter = formatter end end
format_and_send(level, *msgs, &block)
click to toggle source
Allows for passing exceptions in explicitly, which format with backtrace
# File lib/one_apm/logger/agent_logger.rb, line 98 def format_and_send(level, *msgs, &block) if block if @log.send("#{level}?") msgs = Array(block.call) else msgs = [] end end msgs.flatten.each do |item| case item when Exception then log_exception(level, item, :debug) else @log.send(level, item) end end end
gather_startup_logs()
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 191 def gather_startup_logs StartupLogger.instance.dump(self) end
info(*msgs, &blk)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 34 def info(*msgs, &blk) format_and_send(:info, msgs, &blk) end
is_startup_logger?()
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 67 def is_startup_logger? @log.is_a?(NullLogger) end
log_exception(level, e, backtrace_level=level)
click to toggle source
Use this when you want to log an exception with explicit control over the log level that the backtrace is logged at. If you just want the default behavior of backtraces logged at debug, use one of the methods above and pass an Exception as one of the args.
# File lib/one_apm/logger/agent_logger.rb, line 75 def log_exception(level, e, backtrace_level=level) @log.send(level, "%p: %s" % [ e.class, e.message ]) @log.send(backtrace_level) do backtrace = backtrace_from_exception(e) if backtrace "Debugging backtrace:\n" + backtrace.join("\n ") else "No backtrace available." end end end
log_formatter=(formatter)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 195 def log_formatter=(formatter) @log.formatter = formatter end
log_once(level, key, *msgs)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 44 def log_once(level, key, *msgs) # Since `already_logged` might change between calls, just grab it once # and use it throughout this method. logged = already_logged return if logged.include?(key) if logged.size >= OA_NUM_LOG_ONCE_KEYS && key.kind_of?(String) # The reason for preventing too many keys in `logged` is for # memory concerns. # The reason for checking the type of the key is that we always want # to allow symbols to log, since there are very few of them. # The assumption here is that you would NEVER pass dynamically-created # symbols, because you would never create symbols dynamically in the # first place, as that would already be a memory leak in most Rubies, # even if we didn't hang on to them all here. return end logged[key] = true self.send(level, *msgs) end
set_log_format!()
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 183 def set_log_format! @hostname = OneApm::Agent::Hostname.get @prefix = wants_stdout? ? '** [OneApm]' : '' @log.formatter = Proc.new do |severity, timestamp, progname, msg| "#{@prefix}[#{timestamp.strftime("%m/%d/%y %H:%M:%S %z")} #{@hostname} (#{$$})] #{severity} : #{msg}\n" end end
set_log_level!()
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 167 def set_log_level! @log.level = AgentLogger.log_level_for(OneApm::Manager.config[:log_level]) end
wants_stdout?()
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 153 def wants_stdout? OneApm::Manager.config[:log_file_path].upcase == "STDOUT" end
warn(*msgs, &blk)
click to toggle source
# File lib/one_apm/logger/agent_logger.rb, line 30 def warn(*msgs, &blk) format_and_send(:warn, msgs, &blk) end