class Selenium::WebDriver::Logger
@example Enable full logging
Selenium::WebDriver.logger.level = :debug
@example Log to file
Selenium::WebDriver.logger.output = 'selenium.log'
@example Use logger manually
Selenium::WebDriver.logger.info('This is info message') Selenium::WebDriver.logger.warn('This is warning message')
Public Class Methods
Source
# File lib/selenium/webdriver/common/logger.rb, line 51 def initialize(progname = 'Selenium', default_level: nil, ignored: nil, allowed: nil) default_level ||= $DEBUG || ENV.key?('DEBUG') ? :debug : :warn @logger = create_logger(progname, level: default_level) @ignored = Array(ignored) @allowed = Array(allowed) @first_warning = false end
@param [String] progname Allow child projects to use Selenium’s Logger
pattern
Public Instance Methods
Source
# File lib/selenium/webdriver/common/logger.rb, line 106 def allow(*ids) @allowed += Array(ids).flatten end
Will only log the provided ID.
@param [Array, Symbol] ids
Source
# File lib/selenium/webdriver/common/logger.rb, line 118 def debug(message, id: [], &block) discard_or_log(:debug, message, id, &block) end
Used to supply information of interest for debugging a problem Overrides default debug
to skip ignored messages by provided id
@param [String] message @param [Symbol, Array<Symbol>] id @yield see deprecate
Source
# File lib/selenium/webdriver/common/logger.rb, line 164 def deprecate(old, new = nil, id: [], reference: '', &block) id = Array(id) return if @ignored.include?(:deprecations) id << :deprecations if @allowed.include?(:deprecations) message = "[DEPRECATION] #{old} is deprecated" message << if new ". Use #{new} instead." else ' and will be removed in a future release.' end message << " See explanation for this deprecation: #{reference}." unless reference.empty? discard_or_log(:warn, message, id, &block) end
Marks code as deprecated with/without replacement.
@param [String] old @param [String, nil] new @param [Symbol, Array<Symbol>] id @param [String] reference @yield appends additional message to end of provided template
Source
# File lib/selenium/webdriver/common/logger.rb, line 140 def error(message, id: [], &block) discard_or_log(:error, message, id, &block) end
Used to supply information that suggests an error occurred
@param [String] message @param [Symbol, Array<Symbol>] id @yield see deprecate
Source
# File lib/selenium/webdriver/common/logger.rb, line 97 def ignore(*ids) @ignored += Array(ids).flatten end
Will not log the provided ID.
@param [Array, Symbol] ids
Source
# File lib/selenium/webdriver/common/logger.rb, line 129 def info(message, id: [], &block) discard_or_log(:info, message, id, &block) end
Used to supply information of general interest
@param [String] message @param [Symbol, Array<Symbol>] id @yield see deprecate
Source
# File lib/selenium/webdriver/common/logger.rb, line 88 def io @logger.instance_variable_get(:@logdev).dev end
Returns IO object used by logger internally.
Normally, we would have never needed it, but we want to use it as IO object for all child processes to ensure their output is redirected there.
It is only used in debug level, in other cases output is suppressed.
@api private
Source
# File lib/selenium/webdriver/common/logger.rb, line 60 def level=(level) if level == :info && @logger.level == :info info(':info is now the default log level, to see additional logging, set log level to :debug') end @logger.level = level end
Source
# File lib/selenium/webdriver/common/logger.rb, line 73 def output=(io) @logger.reopen(io) end
Changes logger output to a new IO.
@param [String] io
Source
# File lib/selenium/webdriver/common/logger.rb, line 151 def warn(message, id: [], &block) discard_or_log(:warn, message, id, &block) end
Used to supply information that suggests action be taken by user
@param [String] message @param [Symbol, Array<Symbol>] id @yield see deprecate
Private Instance Methods
Source
# File lib/selenium/webdriver/common/logger.rb, line 183 def create_logger(name, level:) logger = ::Logger.new($stderr) logger.progname = name logger.level = level logger.formatter = proc do |severity, time, progname, msg| "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n".force_encoding('UTF-8') end logger end
Source
# File lib/selenium/webdriver/common/logger.rb, line 194 def discard_or_log(level, message, id) id = Array(id) return if @ignored.intersect?(id) return if @allowed.any? && (@allowed & id).none? return if ::Logger::Severity.const_get(level.upcase) < @logger.level unless @first_warning @first_warning = true info("Details on how to use and modify Selenium logger:\n", id: [:logger_info]) do "https://selenium.dev/documentation/webdriver/troubleshooting/logging\n" end end msg = id.empty? ? message : "[#{id.map(&:inspect).join(', ')}] #{message} " msg += " #{yield}" if block_given? @logger.send(level) { msg } end