Class: Logged::Logger

Inherits:
Object
  • Object
show all
Includes:
TaggedLogging
Defined in:
lib/logged/logger.rb

Overview

Logger wrapping a component

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TaggedLogging

#current_tags, #flush, #pop_tags, #push_tags, #tagged

Constructor Details

#initialize(loggers, component, formatter) ⇒ Logger

Returns a new instance of Logger.



14
15
16
17
18
19
 
# File 'lib/logged/logger.rb', line 14

def initialize(loggers, component, formatter)
  @loggers   = loggers
  @component = component
  @formatter = formatter
  @enabled   = true
end

Instance Attribute Details

#component ⇒ Object (readonly)

Returns the value of attribute component.



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

def component
  @component
end

#enabled=(value) ⇒ Object (writeonly)

Sets the attribute enabled

Parameters:

  • value —

    the value to set the attribute enabled to.



12
13
14
 
# File 'lib/logged/logger.rb', line 12

def enabled=(value)
  @enabled = value
end

#loggers ⇒ Object (readonly)

Returns the value of attribute loggers.



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

def loggers
  @loggers
end

Instance Method Details

#<<(_msg) ⇒ Object 



63
 
# File 'lib/logged/logger.rb', line 63

def <<(_msg); end

#add(severity, message = nil, progname = nil) ⇒ Object Also known as: log 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/logged/logger.rb', line 21

def add(severity, message = nil, progname = nil)
  return unless enabled?

  message = yield    if block_given? && message.blank?
  message = progname if message.blank?

  data, event = extract_data_and_event(message)

  return if data.blank?

  level = Logged.level_to_sym(severity)

  @loggers.each do |logger, options|
    next unless logger.send("#{level}?")

    add_to_logger(level, event, data, logger, options)
  end
end

#close ⇒ Object 



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

def close
  @loggers.each_key do |logger|
    logger.close if logger.respond_to?(:close)
  end
end

#datetime_format ⇒ Object 



59
 
# File 'lib/logged/logger.rb', line 59

def datetime_format; end

#datetime_format=(_format) ⇒ Object 



61
 
# File 'lib/logged/logger.rb', line 61

def datetime_format=(_format); end

#disable! ⇒ Object 



73
74
75
 
# File 'lib/logged/logger.rb', line 73

def disable!
  self.enabled = false
end

#enable! ⇒ Object 



69
70
71
 
# File 'lib/logged/logger.rb', line 69

def enable!
  self.enabled = true
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/logged/logger.rb', line 65

def enabled?
  @enabled
end