Class: Logsly::Logging182::Appender
- Inherits:
-
Object
- Object
- Logsly::Logging182::Appender
- Defined in:
- lib/logsly/logging182/appender.rb
Overview
The Appender
class is provides methods for appending log events to a logging destination. The log events are formatted into strings using a Layout.
All other Appenders inherit from this class which provides stub methods. Each subclass should provide a write
method that will write log messages to the logging destination.
A private sync
method is provided for use by subclasses. It is used to synchronize writes to the logging destination, and can be used by subclasses to synchronize the closing or flushing of the logging destination.
Direct Known Subclasses
Logsly::Logging182::Appenders::Email, Logsly::Logging182::Appenders::Growl, Logsly::Logging182::Appenders::IO, Logsly::Logging182::Appenders::Syslog
Instance Attribute Summary collapse
-
#layout ⇒ Object
Returns the value of attribute layout.
-
#level ⇒ Object
Returns the value of attribute level.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
Instance Method Summary collapse
-
#<<(str) ⇒ Object
call-seq: appender << string.
-
#append(event) ⇒ Object
call-seq: append( event ).
-
#close(footer = true) ⇒ Object
call-seq: close( footer = true ).
-
#closed? ⇒ Boolean
call-seq: closed?.
-
#encoding ⇒ Object
Returns the current Encoding for the appender or nil if an encoding has not been set.
-
#encoding=(value) ⇒ Object
Set the appender encoding to the given value.
-
#flush ⇒ Object
call-seq: flush.
-
#initialize(name, opts = {}) ⇒ Appender
constructor
call-seq: Appender.new( name ) Appender.new( name, :layout => layout ).
-
#inspect ⇒ Object
call-seq: inspect => string.
-
#reopen ⇒ Object
Reopen the connection to the underlying logging destination.
Constructor Details
#initialize(name, opts = {}) ⇒ Appender
call-seq:
Appender.new( name )
Appender.new( name, :layout => layout )
Creates a new appender using the given name. If no Layout is specified, then a Basic layout will be used. Any logging header supplied by the layout will be written to the logging destination when the Appender is created.
Options:
:layout => the layout to use when formatting log events
:level => the level at which to log
:encoding => encoding to use when writing messages (defaults to UTF-8)
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/logsly/logging182/appender.rb', line 36 def initialize( name, opts = {} ) ::Logsly::Logging182.init unless ::Logsly::Logging182.initialized? @name = name.to_s @closed = false self.layout = opts.getopt(:layout, ::Logsly::Logging182::Layouts::Basic.new) self.level = opts.getopt(:level) self.encoding = opts.fetch(:encoding, self.encoding) @mutex = ReentrantMutex.new if opts.getopt(:header, true) header = @layout.header unless header.nil? || header.empty? begin write(header) rescue StandardError => err ::Logsly::Logging182.log_internal(-2) {err} end end end ::Logsly::Logging182::Appenders[@name] = self end |
Instance Attribute Details
#layout ⇒ Object
Returns the value of attribute layout.
19 20 21 |
# File 'lib/logsly/logging182/appender.rb', line 19 def layout @layout end |
#level ⇒ Object
Returns the value of attribute level.
19 20 21 |
# File 'lib/logsly/logging182/appender.rb', line 19 def level @level end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
19 20 21 |
# File 'lib/logsly/logging182/appender.rb', line 19 def name @name end |
Instance Method Details
#<<(str) ⇒ Object
call-seq:
appender << string
Write the given string to the logging destination “as is” – no layout formatting will be performed.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/logsly/logging182/appender.rb', line 94 def <<( str ) if @closed raise RuntimeError, "appender '<#{self.class.name}: #{@name}>' is closed" end unless @level >= ::Logsly::Logging182::LEVELS.length begin write(str) rescue StandardError => err ::Logsly::Logging182.log_internal(-2) {err} end end self end |
#append(event) ⇒ Object
call-seq:
append( event )
Write the given event to the logging destination. The log event will be processed through the Layout associated with the Appender.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/logsly/logging182/appender.rb', line 69 def append( event ) if @closed raise RuntimeError, "appender '<#{self.class.name}: #{@name}>' is closed" end # only append if the event level is less than or equal to the configured # appender level unless @level > event.level begin write(event) rescue StandardError => err ::Logsly::Logging182.log_internal(-2) {err} end end self end |
#close(footer = true) ⇒ Object
call-seq:
close( = true )
Close the appender and writes the layout footer to the logging destination if the footer flag is set to true
. Log events will no longer be written to the logging destination after the appender is closed.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/logsly/logging182/appender.rb', line 173 def close( = true ) return self if @closed ::Logsly::Logging182::Appenders.remove(@name) @closed = true flush if = @layout. unless .nil? || .empty? begin write() rescue StandardError => err ::Logsly::Logging182.log_internal(-2) {err} end end end self end |
#closed? ⇒ Boolean
call-seq:
closed?
Returns true
if the appender has been closed; returns false
otherwise. When an appender is closed, no more log events can be written to the logging destination.
200 201 202 |
# File 'lib/logsly/logging182/appender.rb', line 200 def closed? @closed end |
#encoding ⇒ Object
Returns the current Encoding for the appender or nil if an encoding has not been set.
239 240 241 242 |
# File 'lib/logsly/logging182/appender.rb', line 239 def encoding return @encoding if defined? @encoding @encoding = Object.const_defined?(:Encoding) ? Encoding.default_external : nil end |
#encoding=(value) ⇒ Object
Set the appender encoding to the given value. The value can either be an Encoding instance or a String or Symbol referring to a valid encoding.
This method only applies to Ruby 1.9 or later. The encoding will always be nil for older Rubies.
value - The encoding as a String, Symbol, or Encoding instance.
Raises ArgumentError if the value is not a valid encoding.
254 255 256 257 258 259 260 |
# File 'lib/logsly/logging182/appender.rb', line 254 def encoding=( value ) if value.nil? @encoding = nil else @encoding = Object.const_defined?(:Encoding) ? Encoding.find(value.to_s) : nil end end |
#flush ⇒ Object
call-seq:
flush
Call flush
to force an appender to write out any buffered log events. Similar to IO#flush, so use in a similar fashion.
219 220 221 |
# File 'lib/logsly/logging182/appender.rb', line 219 def flush self end |
#inspect ⇒ Object
call-seq:
inspect => string
Returns a string representation of the appender.
228 229 230 231 232 233 234 |
# File 'lib/logsly/logging182/appender.rb', line 228 def inspect "<%s:0x%x name=\"%s\">" % [ self.class.name.sub(%r/^Logsly::Logging182::/, ''), self.object_id, self.name ] end |
#reopen ⇒ Object
Reopen the connection to the underlying logging destination. If the connection is currently closed then it will be opened. If the connection is currently open then it will be closed and immediately opened.
208 209 210 211 |
# File 'lib/logsly/logging182/appender.rb', line 208 def reopen @closed = false self end |