Class: Hubkit::Logger

Inherits:
Object
  • Object
show all
Defined in:
lib/hubkit/logger.rb

Overview

The logger Hubkit uses for diagnostic info. If used in a Rails app and that Rails app already has a logger, it will use that same logger. Prepends [HUBKIT] to all log statements for easy filtering.

Class Method Summary collapse

Class Method Details

.debug(msg) ⇒ Boolean

Write a debug level message to the log

Parameters:

  • msg (String) —

    the message to log

Returns:

  • (Boolean) —

    true


11
12
13
 
# File 'lib/hubkit/logger.rb', line 11

def self.debug(msg)
  inner_logger.debug('[HUBKIT] ' + msg)
end

.error(msg) ⇒ Boolean

Write a error level message to the log

Parameters:

  • msg (String) —

    the message to log

Returns:

  • (Boolean) —

    true


32
33
34
 
# File 'lib/hubkit/logger.rb', line 32

def self.error(msg)
  inner_logger.error('[HUBKIT] ' + msg)
end

.fatal(msg) ⇒ Boolean

Write a fatal level message to the log

Parameters:

  • msg (String) —

    the message to log

Returns:

  • (Boolean) —

    true


39
40
41
 
# File 'lib/hubkit/logger.rb', line 39

def self.fatal(msg)
  inner_logger.fatal('[HUBKIT] ' + msg)
end

.info(msg) ⇒ Boolean

Write a info level message to the log

Parameters:

  • msg (String) —

    the message to log

Returns:

  • (Boolean) —

    true


18
19
20
 
# File 'lib/hubkit/logger.rb', line 18

def self.info(msg)
  inner_logger.info('[HUBKIT] ' + msg)
end

.inner_logger ⇒ Logger

Return the ruby logger used by Hubkit

Returns:

  • (Logger) —

    the logger. Rails is in use, will reuse the Rails logger.


53
54
55
56
57
58
59
60
 
# File 'lib/hubkit/logger.rb', line 53

def self.inner_logger
  @_inner_logger ||=
    if Kernel.const_defined? 'Rails'
      Rails.logger
    else
      ::Logger.new(STDERR)
    end
end

.unknown(msg) ⇒ Boolean

Write a unknown level message to the log

Parameters:

  • msg (String) —

    the message to log

Returns:

  • (Boolean) —

    true


46
47
48
 
# File 'lib/hubkit/logger.rb', line 46

def self.unknown(msg)
  inner_logger.unknown('[HUBKIT] ' + msg)
end

.warn(msg) ⇒ Boolean

Write a warning level message to the log

Parameters:

  • msg (String) —

    the message to log

Returns:

  • (Boolean) —

    true


25
26
27
 
# File 'lib/hubkit/logger.rb', line 25

def self.warn(msg)
  inner_logger.warn('[HUBKIT] ' + msg)
end