Class: Logger

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.debug? ⇒ Boolean

Check if debug logging is enabled

Returns:

  • (Boolean) —

    true if debug is enabled, false otherwise



34
35
36
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 34

def debug?
  @debug
end

.set_debug(value = false) ⇒ Object

Enable or disable debug logging

Parameters:

  • value (Boolean) (defaults to: false) —

    true to enable debug logging, false to disable



28
29
30
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 28

def set_debug(value = false)
  @debug = value
end

Instance Method Details

#error(message) ⇒ Object

Log error message (always shown)

Parameters:

  • message (String) —

    the error message to log



55
56
57
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 55

def error(message)
  puts "#{timestamp} ERROR #{colorize(message, :red)}"
end

#info(message) ⇒ Object

Log info message (always shown)

Parameters:

  • message (String) —

    the info message to log



77
78
79
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 77

def info(message)
  puts "#{timestamp} INFO #{colorize(message, :blue)}"
end

#log(message) ⇒ Object

Log debug message (only if debug is enabled)

Parameters:

  • message (String) —

    the message to log



47
48
49
50
51
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 47

def log(message)
  return unless self.class.debug?

  puts "#{timestamp} DEBUG #{message}"
end

#success(message) ⇒ Object

Log success message (only if debug is enabled)

Parameters:

  • message (String) —

    the success message to log



69
70
71
72
73
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 69

def success(message)
  return unless self.class.debug?

  puts "#{timestamp} SUCCESS #{colorize(message, :green)}"
end

#timestamp ⇒ String

Generate timestamp for log messages

Returns:

  • (String) —

    formatted timestamp



41
42
43
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 41

def timestamp
  "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")} AppConfiguration"
end

#warning(message) ⇒ Object

Log warning message (only if debug is enabled)

Parameters:

  • message (String) —

    the warning message to log



61
62
63
64
65
 
# File 'lib/ibm_appconfiguration_ruby_sdk/configurations/internal/logger.rb', line 61

def warning(message)
  return unless self.class.debug?

  puts "#{timestamp} WARNING #{colorize(message, :yellow)}"
end