Class: DRbService::HtmlLogFormatter

Inherits:

Logger::Formatter

• Object
• Logger::Formatter
• DRbService::HtmlLogFormatter

Includes:

ERB::Util

Defined in:

lib/drbservice/utils.rb

Overview

An alternate formatter for Logger instances that outputs div HTML fragments.

Usage

require 'drbservice/utils'
DRbService.logger.formatter = DRbService::HtmlLogFormatter.new( DRbService.logger )

Version

$Id: utils.rb,v 87bc5aa9e2be 2011/08/29 21:05:42 ged $

Authors

• Michael Granger <ged@FaerieMUD.org>

:include: LICENSE

–

Please see the file LICENSE in the ‘docs’ directory for licensing details.

Constant Summary

HTML_LOG_FORMAT =

The default HTML fragment that’ll be used as the template for each log message.

%q{
<div class="log-message %5$s">
	<span class="log-time">%1$s.%2$06d</span>
	[
		<span class="log-pid">%3$d</span>
		/
		<span class="log-tid">%4$s</span>
	]
	<span class="log-level">%5$s</span>
	:
	<span class="log-name">%6$s</span>
	<span class="log-message-text">%7$s</span>
</div>
}

Instance Attribute Summary

• #format ⇒ Object

  The HTML fragment that will be used as a format() string for the log.

Instance Method Summary

• #call(severity, time, progname, msg) ⇒ Object

  Return a log message composed out of the arguments formatted using the formatter’s format string.

• #initialize(logger, format = HTML_LOG_FORMAT) ⇒ HtmlLogFormatter constructor

  Override the logging formats with ones that generate HTML fragments.

Constructor Details

#initialize(logger, format = HTML_LOG_FORMAT) ⇒ HtmlLogFormatter

Override the logging formats with ones that generate HTML fragments

# File 'lib/drbservice/utils.rb', line 270

def initialize( logger, format=HTML_LOG_FORMAT ) # :notnew:
	@logger = logger
	@format = format
	super()
end

Instance Attribute Details

#format ⇒ Object

The HTML fragment that will be used as a format() string for the log

# File 'lib/drbservice/utils.rb', line 282

def format
  @format
end

Instance Method Details

#call(severity, time, progname, msg) ⇒ Object

Return a log message composed out of the arguments formatted using the formatter’s format string

# File 'lib/drbservice/utils.rb', line 287

def call( severity, time, progname, msg )
	args = [
		time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
		time.usec,                                                    # %2$d
		Process.pid,                                                  # %3$d
		Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
		severity.downcase,                                                     # %5$s
		progname,                                                     # %6$s
		html_escape( msg ).gsub(/\n/, '<br />')                       # %7$s
	]

	return self.format % args
end