Class: IbmAppconfigurationRubySdk::Logger

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Logger

Returns a new instance of Logger.



28
29
30
31
32
33
34
35
36
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 28

def initialize
  @debug = false
  @log   = ::Logger.new($stdout)
  @log.progname  = "AppConfiguration"
  @log.level     = ::Logger::INFO
  @log.formatter = proc do |severity, datetime, progname, msg|
    "#{datetime.strftime("%Y-%m-%d %H:%M:%S")} #{progname} #{severity} #{msg}\n"
  end
end

Instance Attribute Details

#debug ⇒ Boolean

Returns whether debug-level logging is enabled.

Returns:

  • (Boolean) —

    whether debug-level logging is enabled



26
27
28
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 26

def debug
  @debug
end

Class Method Details

.set_debug(value = false) ⇒ Object

Backward-compatible class-level shim — delegates to the singleton instance.

Parameters:

  • value (Boolean) (defaults to: false) 


40
41
42
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 40

def self.set_debug(value = false)
  instance.debug = value
end

Instance Method Details

#error(message) ⇒ Object

Log an error message (always emitted).

Parameters:

  • message (String) 


61
62
63
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 61

def error(message)
  @log.error(message)
end

#info(message) ⇒ Object

Log an informational message (always emitted).

Parameters:

  • message (String) 


83
84
85
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 83

def info(message)
  @log.info(message)
end

#log(message) ⇒ Object

Log a debug message (only when debug is enabled).

Parameters:

  • message (String) 


53
54
55
56
57
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 53

def log(message)
  return unless @debug

  @log.debug(message)
end

#success(message) ⇒ Object

Log a success/progress message (only when debug is enabled).

Parameters:

  • message (String) 


75
76
77
78
79
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 75

def success(message)
  return unless @debug

  @log.info(message)
end

#warning(message) ⇒ Object

Log a warning message (only when debug is enabled).

Parameters:

  • message (String) 


67
68
69
70
71
 
# File 'lib/ibm_appconfiguration_ruby_sdk/logger.rb', line 67

def warning(message)
  return unless @debug

  @log.warn(message)
end