Class: SemanticLogger::Appenders

Inherits:
Concurrent::Array
  • Object
show all
Defined in:
lib/semantic_logger/appenders.rb

Overview

Manage a collection of appenders.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(logger = Processor.logger.dup) ⇒ Appenders

Returns a new instance of Appenders.



6
7
8
9
10
 
# File 'lib/semantic_logger/appenders.rb', line 6

def initialize(logger = Processor.logger.dup)
  @logger      = logger
  @logger.name = self.class.name
  super()
end

Instance Attribute Details

#logger ⇒ Object

Returns the value of attribute logger.



4
5
6
 
# File 'lib/semantic_logger/appenders.rb', line 4

def logger
  @logger
end

Instance Method Details

#add(**args) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/semantic_logger/appenders.rb', line 12

def add(**args, &)
  appender = SemanticLogger::Appender.factory(**args, &)

  stream = appender.respond_to?(:console_stream) && appender.console_stream
  if stream && console_streams.include?(stream)
    logger.warn "Ignoring attempt to add a second #{stream} console appender since it would result in duplicate console output."
    return
  end

  self << appender
  appender
end

#close ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/semantic_logger/appenders.rb', line 69

def close
  closed_appenders = []
  each do |appender|
    logger.trace "Closing appender: #{appender.name}"
    appender.flush
    appender.close
    closed_appenders << appender
  rescue Exception => e
    logger.error "Failed to close appender: #{appender.name}", e
  end
  # Delete appenders outside the #each above which prevents changes during iteration.
  closed_appenders.each { |appender| delete(appender) }
  logger.trace "All appenders closed and removed from appender list"
end

#console_output? ⇒ Boolean

Whether any of the existing appenders already output to the console? I.e. Writes to stdout or stderr.

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/semantic_logger/appenders.rb', line 32

def console_output?
  console_streams.any?
end

#console_streams ⇒ Object

The console streams (:stdout and/or :stderr) already being written to by the existing appenders.



26
27
28
 
# File 'lib/semantic_logger/appenders.rb', line 26

def console_streams
  filter_map { |appender| appender.console_stream if appender.respond_to?(:console_stream) }
end

#flush ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/semantic_logger/appenders.rb', line 59

def flush
  each do |appender|
    logger.trace "Flushing appender: #{appender.name}"
    appender.flush
  rescue Exception => e
    logger.error "Failed to flush appender: #{appender.name}", e
  end
  logger.trace "All appenders flushed"
end

#log(log) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/semantic_logger/appenders.rb', line 51

def log(log)
  each do |appender|
    appender.log(log) if appender.should_log?(log)
  rescue Exception => e
    logger.error "Failed to log to appender: #{appender.name}", e
  end
end

#reopen ⇒ Object

After a fork reopen each appender.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/semantic_logger/appenders.rb', line 85

def reopen
  each do |appender|
    next unless appender.respond_to?(:reopen)

    logger.trace "Reopening appender: #{appender.name}"
    appender.reopen
  rescue Exception => e
    logger.error "Failed to re-open appender: #{appender.name}", e
  end
  logger.trace "All appenders re-opened"
end

#stats ⇒ Object

Returns [Array] operational statistics for each appender.

Appenders that run asynchronously (see SemanticLogger::Appender::Async#stats) report their queue size and processed/dropped counts. Appenders that log inline on the processor thread report only their name with async: false.



41
42
43
44
45
46
47
48
49
 
# File 'lib/semantic_logger/appenders.rb', line 41

def stats
  map do |appender|
    if appender.respond_to?(:stats)
      appender.stats
    else
      {name: appender.name, async: false}
    end
  end
end