cpowell-SyslogLogger 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- data/History.txt +7 -0
- data/README.rdoc +115 -0
- data/Rakefile +15 -0
- data/lib/analyzer_tools/syslog_logger.rb +1 -0
- data/lib/syslog_logger.rb +136 -0
- data/sysloglogger.gemspec +32 -0
- data/test/test_syslog_logger.rb +491 -0
- metadata +68 -0
data/History.txt
ADDED
data/README.rdoc
ADDED
@@ -0,0 +1,115 @@
|
|
1
|
+
= SyslogLogger
|
2
|
+
|
3
|
+
http://github.com/cpowell/sysloglogger/tree
|
4
|
+
|
5
|
+
== DESCRIPTION:
|
6
|
+
|
7
|
+
SyslogLogger is a Logger replacement that logs to syslog. It is almost drop-in
|
8
|
+
with a few caveats. You can add SyslogLogger to your Rails production
|
9
|
+
environment to aggregate logs between multiple machines.
|
10
|
+
|
11
|
+
NOTE! You can only set the SyslogLogger program name when you initialize
|
12
|
+
SyslogLogger for the first time. This is a limitation of the way SyslogLogger
|
13
|
+
uses syslog (and in some ways, a limitation of the way syslog(3) works).
|
14
|
+
Attempts to change SyslogLogger's program name after the first initialization
|
15
|
+
will be ignored.
|
16
|
+
|
17
|
+
This particular SyslogLogger is a fork of the original, which can be found here:
|
18
|
+
|
19
|
+
http://seattlerb.rubyforge.org/SyslogLogger
|
20
|
+
|
21
|
+
== SYNOPSIS:
|
22
|
+
|
23
|
+
=== config/environment.rb
|
24
|
+
|
25
|
+
config.gem "cpowell-SyslogLogger", :source=>'http://gems.github.com', :lib=>'syslog_logger'
|
26
|
+
|
27
|
+
=== config/environments/production.rb
|
28
|
+
|
29
|
+
(Only this environment, since you probably only want to enable it for Production, and not Test or Development.)
|
30
|
+
|
31
|
+
require 'syslog_logger'
|
32
|
+
RAILS_DEFAULT_LOGGER = SyslogLogger.new
|
33
|
+
|
34
|
+
By default, SyslogLogger uses the program name 'rails', but this can be
|
35
|
+
changed via the first argument to SyslogLogger.new:
|
36
|
+
|
37
|
+
RAILS_DEFAULT_LOGGER = SyslogLogger.new(program_name = 'mygreatapp')
|
38
|
+
|
39
|
+
=== BSD syslog setup
|
40
|
+
|
41
|
+
==== /etc/syslog.conf
|
42
|
+
|
43
|
+
Add the following lines:
|
44
|
+
|
45
|
+
!rails
|
46
|
+
*.* /var/log/production.log
|
47
|
+
|
48
|
+
Then touch /var/log/production.log and signal syslogd with a HUP
|
49
|
+
(killall -HUP syslogd, on FreeBSD).
|
50
|
+
|
51
|
+
==== /etc/newsyslog.conf
|
52
|
+
|
53
|
+
Add the following line:
|
54
|
+
|
55
|
+
/var/log/production.log 640 7 * @T00 Z
|
56
|
+
|
57
|
+
This creates a log file that is rotated every day at midnight, gzip'd, then
|
58
|
+
kept for 7 days. Consult newsyslog.conf(5) for more details.
|
59
|
+
|
60
|
+
=== syslog-ng setup
|
61
|
+
|
62
|
+
==== syslog-ng.conf
|
63
|
+
|
64
|
+
A basic setup:
|
65
|
+
|
66
|
+
destination rails_log { file("/var/log/production.log"); };
|
67
|
+
filter f_rails { program("rails.*"); };
|
68
|
+
log { source(src); filter(f_rails); destination(rails_log); };
|
69
|
+
|
70
|
+
A more advanced setup with formatting, etc:
|
71
|
+
|
72
|
+
destination rails { file("/var/log/rails_apps" owner("rails") group("rails") perm(0664) template("$DATE $HOST $PROGRAM [$LEVEL] $MSGONLY\n") template_escape(no) ); };
|
73
|
+
filter f_rails { (program("railsappone") or program("railsapptwo")) and not match("SQL ") and not match("SELECT") and not match("INSERT INTO") and not match("UPDATE"); };
|
74
|
+
log { source(src); filter(f_rails); destination(rails); };
|
75
|
+
|
76
|
+
=== Starting
|
77
|
+
|
78
|
+
Now restart your Rails app. Your production logs should now be showing up in
|
79
|
+
/var/log/production.log. If you have mulitple machines, you can log them all
|
80
|
+
to a central machine with remote syslog logging for analysis. Consult your
|
81
|
+
syslogd(8) manpage for further details.
|
82
|
+
|
83
|
+
== INSTALL:
|
84
|
+
|
85
|
+
$ gem sources -a http://gems.github.com (you only have to do this once)
|
86
|
+
$ sudo gem install cpowell-SyslogLogger
|
87
|
+
|
88
|
+
== LICENSE:
|
89
|
+
|
90
|
+
The original code is Copyright (c) Eric Hodel.
|
91
|
+
|
92
|
+
For any additional code...
|
93
|
+
|
94
|
+
Copyright (c) 2008 Christopher Powell
|
95
|
+
|
96
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
97
|
+
a copy of this software and associated documentation files (the
|
98
|
+
'Software'), to deal in the Software without restriction, including
|
99
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
100
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
101
|
+
permit persons to whom the Software is furnished to do so, subject to
|
102
|
+
the following conditions:
|
103
|
+
|
104
|
+
The above copyright notice and this permission notice shall be
|
105
|
+
included in all copies or substantial portions of the Software.
|
106
|
+
|
107
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
108
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
109
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
110
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
111
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
112
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
113
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
114
|
+
|
115
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
require 'echoe'
|
4
|
+
require './lib/syslog_logger.rb'
|
5
|
+
|
6
|
+
Echoe.new('SyslogLogger', SyslogLogger::VERSION) do |p|
|
7
|
+
p.author = 'Eric Hodel; Chris Powell'
|
8
|
+
p.email = 'drbrain@segment7.net; cpowell@prylis.com'
|
9
|
+
p.description = "An improved Logger replacement that logs to syslog. It is almost drop-in with a few caveats."
|
10
|
+
p.url = "http://github.com/cpowell/sysloglogger"
|
11
|
+
p.ignore_pattern = ["tmp/*", "script/*"]
|
12
|
+
p.development_dependencies = []
|
13
|
+
end
|
14
|
+
|
15
|
+
Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'syslog_logger' # for compatibility
|
@@ -0,0 +1,136 @@
|
|
1
|
+
require 'syslog'
|
2
|
+
require 'logger'
|
3
|
+
|
4
|
+
class SyslogLogger
|
5
|
+
|
6
|
+
##
|
7
|
+
# The version of SyslogLogger you are using.
|
8
|
+
|
9
|
+
VERSION = '1.4.1'
|
10
|
+
|
11
|
+
# From 'man syslog.h':
|
12
|
+
# LOG_EMERG A panic condition was reported to all processes.
|
13
|
+
# LOG_ALERT A condition that should be corrected immediately.
|
14
|
+
# LOG_CRIT A critical condition.
|
15
|
+
# LOG_ERR An error message.
|
16
|
+
# LOG_WARNING A warning message.
|
17
|
+
# LOG_NOTICE A condition requiring special handling.
|
18
|
+
# LOG_INFO A general information message.
|
19
|
+
# LOG_DEBUG A message useful for debugging programs.
|
20
|
+
|
21
|
+
# From logger rdoc:
|
22
|
+
# FATAL: an unhandleable error that results in a program crash
|
23
|
+
# ERROR: a handleable error condition
|
24
|
+
# WARN: a warning
|
25
|
+
# INFO: generic (useful) information about system operation
|
26
|
+
# DEBUG: low-level information for developers
|
27
|
+
|
28
|
+
##
|
29
|
+
# Maps Logger warning types to syslog(3) warning types.
|
30
|
+
|
31
|
+
LOGGER_MAP = {
|
32
|
+
:unknown => :alert,
|
33
|
+
:fatal => :alert,
|
34
|
+
:error => :err,
|
35
|
+
:warn => :warning,
|
36
|
+
:info => :info,
|
37
|
+
:debug => :debug
|
38
|
+
}
|
39
|
+
|
40
|
+
##
|
41
|
+
# Maps Logger log levels to their values so we can silence.
|
42
|
+
|
43
|
+
LOGGER_LEVEL_MAP = {}
|
44
|
+
|
45
|
+
LOGGER_MAP.each_key do |key|
|
46
|
+
LOGGER_LEVEL_MAP[key] = Logger.const_get key.to_s.upcase
|
47
|
+
end
|
48
|
+
|
49
|
+
##
|
50
|
+
# Maps Logger log level values to syslog log levels.
|
51
|
+
|
52
|
+
LEVEL_LOGGER_MAP = {}
|
53
|
+
|
54
|
+
LOGGER_LEVEL_MAP.invert.each do |level, severity|
|
55
|
+
LEVEL_LOGGER_MAP[level] = LOGGER_MAP[severity]
|
56
|
+
end
|
57
|
+
|
58
|
+
##
|
59
|
+
# Builds a methods for level +meth+.
|
60
|
+
|
61
|
+
def self.make_methods(meth)
|
62
|
+
eval <<-EOM, nil, __FILE__, __LINE__ + 1
|
63
|
+
def #{meth}(message = nil)
|
64
|
+
return true if #{LOGGER_LEVEL_MAP[meth]} < @level
|
65
|
+
SYSLOG.#{LOGGER_MAP[meth]} clean(message || yield)
|
66
|
+
return true
|
67
|
+
end
|
68
|
+
|
69
|
+
def #{meth}?
|
70
|
+
@level <= Logger::#{meth.to_s.upcase}
|
71
|
+
end
|
72
|
+
EOM
|
73
|
+
end
|
74
|
+
|
75
|
+
LOGGER_MAP.each_key do |level|
|
76
|
+
make_methods level
|
77
|
+
end
|
78
|
+
|
79
|
+
##
|
80
|
+
# Log level for Logger compatibility.
|
81
|
+
|
82
|
+
attr_accessor :level
|
83
|
+
|
84
|
+
##
|
85
|
+
# Fills in variables for Logger compatibility. If this is the first
|
86
|
+
# instance of SyslogLogger, +program_name+ may be set to change the logged
|
87
|
+
# program name.
|
88
|
+
#
|
89
|
+
# Due to the way syslog works, only one program name may be chosen.
|
90
|
+
|
91
|
+
def initialize(program_name = 'rails')
|
92
|
+
@level = Logger::DEBUG
|
93
|
+
|
94
|
+
return if defined? SYSLOG
|
95
|
+
self.class.const_set :SYSLOG, Syslog.open(program_name)
|
96
|
+
end
|
97
|
+
|
98
|
+
##
|
99
|
+
# Almost duplicates Logger#add. +progname+ is ignored.
|
100
|
+
|
101
|
+
def add(severity, message = nil, progname = nil, &block)
|
102
|
+
severity ||= Logger::UNKNOWN
|
103
|
+
return true if severity < @level
|
104
|
+
message = clean(message || block.call)
|
105
|
+
SYSLOG.send LEVEL_LOGGER_MAP[severity], clean(message)
|
106
|
+
return true
|
107
|
+
end
|
108
|
+
|
109
|
+
##
|
110
|
+
# Allows messages of a particular log level to be ignored temporarily.
|
111
|
+
#
|
112
|
+
# Can you say "Broken Windows"?
|
113
|
+
|
114
|
+
def silence(temporary_level = Logger::ERROR)
|
115
|
+
old_logger_level = @level
|
116
|
+
@level = temporary_level
|
117
|
+
yield
|
118
|
+
ensure
|
119
|
+
@level = old_logger_level
|
120
|
+
end
|
121
|
+
|
122
|
+
private
|
123
|
+
|
124
|
+
##
|
125
|
+
# Clean up messages so they're nice and pretty.
|
126
|
+
|
127
|
+
def clean(message)
|
128
|
+
message = message.to_s.dup
|
129
|
+
message.strip!
|
130
|
+
message.gsub!(/%/, '%%') # syslog(3) freaks on % (printf)
|
131
|
+
message.gsub!(/\e\[[^m]*m/, '') # remove useless ansi color codes
|
132
|
+
return message
|
133
|
+
end
|
134
|
+
|
135
|
+
end
|
136
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
Gem::Specification.new do |s|
|
4
|
+
s.name = %q{SyslogLogger}
|
5
|
+
s.version = "1.4.1"
|
6
|
+
|
7
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
|
8
|
+
s.authors = ["Eric Hodel; Chris Powell"]
|
9
|
+
s.date = %q{2008-11-12}
|
10
|
+
s.description = %q{An improved Logger replacement that logs to syslog. It is almost drop-in with a few caveats.}
|
11
|
+
s.email = %q{drbrain@segment7.net; cpowell@prylis.com}
|
12
|
+
s.extra_rdoc_files = ["lib/analyzer_tools/syslog_logger.rb", "lib/syslog_logger.rb", "README.rdoc"]
|
13
|
+
s.files = ["History.txt", "lib/analyzer_tools/syslog_logger.rb", "lib/syslog_logger.rb", "Manifest", "Rakefile", "README.rdoc", "sysloglogger.gemspec", "test/test_syslog_logger.rb", "SyslogLogger.gemspec"]
|
14
|
+
s.has_rdoc = true
|
15
|
+
s.homepage = %q{http://github.com/cpowell/sysloglogger}
|
16
|
+
s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "SyslogLogger", "--main", "README.rdoc"]
|
17
|
+
s.require_paths = ["lib"]
|
18
|
+
s.rubyforge_project = %q{sysloglogger}
|
19
|
+
s.rubygems_version = %q{1.3.1}
|
20
|
+
s.summary = %q{An improved Logger replacement that logs to syslog. It is almost drop-in with a few caveats.}
|
21
|
+
s.test_files = ["test/test_syslog_logger.rb"]
|
22
|
+
|
23
|
+
if s.respond_to? :specification_version then
|
24
|
+
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
25
|
+
s.specification_version = 2
|
26
|
+
|
27
|
+
if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
|
28
|
+
else
|
29
|
+
end
|
30
|
+
else
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,491 @@
|
|
1
|
+
require 'test/unit'
|
2
|
+
require 'tempfile'
|
3
|
+
require 'syslog_logger'
|
4
|
+
|
5
|
+
module MockSyslog; end
|
6
|
+
|
7
|
+
class << MockSyslog
|
8
|
+
|
9
|
+
@line = nil
|
10
|
+
|
11
|
+
SyslogLogger::LOGGER_MAP.values.uniq.each do |level|
|
12
|
+
eval <<-EOM
|
13
|
+
def #{level}(message)
|
14
|
+
@line = "#{level.to_s.upcase} - \#{message}"
|
15
|
+
end
|
16
|
+
EOM
|
17
|
+
end
|
18
|
+
|
19
|
+
attr_reader :line
|
20
|
+
attr_reader :program_name
|
21
|
+
|
22
|
+
def open(program_name)
|
23
|
+
@program_name = program_name
|
24
|
+
end
|
25
|
+
|
26
|
+
def reset
|
27
|
+
@line = ''
|
28
|
+
end
|
29
|
+
|
30
|
+
end
|
31
|
+
|
32
|
+
SyslogLogger.const_set :SYSLOG, MockSyslog
|
33
|
+
|
34
|
+
class TestLogger < Test::Unit::TestCase
|
35
|
+
|
36
|
+
LEVEL_LABEL_MAP = {
|
37
|
+
Logger::DEBUG => 'DEBUG',
|
38
|
+
Logger::INFO => 'INFO',
|
39
|
+
Logger::WARN => 'WARN',
|
40
|
+
Logger::ERROR => 'ERROR',
|
41
|
+
Logger::FATAL => 'FATAL',
|
42
|
+
Logger::UNKNOWN => 'ANY',
|
43
|
+
}
|
44
|
+
|
45
|
+
def setup
|
46
|
+
@logger = Logger.new(nil)
|
47
|
+
end
|
48
|
+
|
49
|
+
class Log
|
50
|
+
attr_reader :line, :label, :datetime, :pid, :severity, :progname, :msg
|
51
|
+
def initialize(line)
|
52
|
+
@line = line
|
53
|
+
/\A(\w+), \[([^#]*)#(\d+)\]\s+(\w+) -- (\w*): ([\x0-\xff]*)/ =~ @line
|
54
|
+
@label, @datetime, @pid, @severity, @progname, @msg = $1, $2, $3, $4, $5, $6
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
def log_add(severity, msg, progname = nil, &block)
|
59
|
+
log(:add, severity, msg, progname, &block)
|
60
|
+
end
|
61
|
+
|
62
|
+
def log(msg_id, *arg, &block)
|
63
|
+
Log.new(log_raw(msg_id, *arg, &block))
|
64
|
+
end
|
65
|
+
|
66
|
+
def log_raw(msg_id, *arg, &block)
|
67
|
+
logdev = Tempfile.new(File.basename(__FILE__) + '.log')
|
68
|
+
@logger.instance_eval { @logdev = Logger::LogDevice.new(logdev) }
|
69
|
+
assert_equal true, @logger.__send__(msg_id, *arg, &block)
|
70
|
+
logdev.open
|
71
|
+
msg = logdev.read
|
72
|
+
logdev.close
|
73
|
+
msg
|
74
|
+
end
|
75
|
+
|
76
|
+
def test_initialize
|
77
|
+
assert_equal Logger::DEBUG, @logger.level
|
78
|
+
end
|
79
|
+
|
80
|
+
def test_add
|
81
|
+
msg = log_add nil, 'unknown level message' # nil == unknown
|
82
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
83
|
+
|
84
|
+
msg = log_add Logger::FATAL, 'fatal level message'
|
85
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
86
|
+
|
87
|
+
msg = log_add Logger::ERROR, 'error level message'
|
88
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
89
|
+
|
90
|
+
msg = log_add Logger::WARN, 'warn level message'
|
91
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
92
|
+
|
93
|
+
msg = log_add Logger::INFO, 'info level message'
|
94
|
+
assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
|
95
|
+
|
96
|
+
msg = log_add Logger::DEBUG, 'debug level message'
|
97
|
+
assert_equal LEVEL_LABEL_MAP[Logger::DEBUG], msg.severity
|
98
|
+
end
|
99
|
+
|
100
|
+
def test_add_level_unknown
|
101
|
+
@logger.level = Logger::UNKNOWN
|
102
|
+
|
103
|
+
msg = log_add nil, 'unknown level message' # nil == unknown
|
104
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
105
|
+
|
106
|
+
msg = log_add Logger::FATAL, 'fatal level message'
|
107
|
+
assert_equal '', msg.line
|
108
|
+
|
109
|
+
msg = log_add Logger::ERROR, 'error level message'
|
110
|
+
assert_equal '', msg.line
|
111
|
+
|
112
|
+
msg = log_add Logger::WARN, 'warn level message'
|
113
|
+
assert_equal '', msg.line
|
114
|
+
|
115
|
+
msg = log_add Logger::INFO, 'info level message'
|
116
|
+
assert_equal '', msg.line
|
117
|
+
|
118
|
+
msg = log_add Logger::DEBUG, 'debug level message'
|
119
|
+
assert_equal '', msg.line
|
120
|
+
end
|
121
|
+
|
122
|
+
def test_add_level_fatal
|
123
|
+
@logger.level = Logger::FATAL
|
124
|
+
|
125
|
+
msg = log_add nil, 'unknown level message' # nil == unknown
|
126
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
127
|
+
|
128
|
+
msg = log_add Logger::FATAL, 'fatal level message'
|
129
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
130
|
+
|
131
|
+
msg = log_add Logger::ERROR, 'error level message'
|
132
|
+
assert_equal '', msg.line
|
133
|
+
|
134
|
+
msg = log_add Logger::WARN, 'warn level message'
|
135
|
+
assert_equal '', msg.line
|
136
|
+
|
137
|
+
msg = log_add Logger::INFO, 'info level message'
|
138
|
+
assert_equal '', msg.line
|
139
|
+
|
140
|
+
msg = log_add Logger::DEBUG, 'debug level message'
|
141
|
+
assert_equal '', msg.line
|
142
|
+
end
|
143
|
+
|
144
|
+
def test_add_level_error
|
145
|
+
@logger.level = Logger::ERROR
|
146
|
+
|
147
|
+
msg = log_add nil, 'unknown level message' # nil == unknown
|
148
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
149
|
+
|
150
|
+
msg = log_add Logger::FATAL, 'fatal level message'
|
151
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
152
|
+
|
153
|
+
msg = log_add Logger::ERROR, 'error level message'
|
154
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
155
|
+
|
156
|
+
msg = log_add Logger::WARN, 'warn level message'
|
157
|
+
assert_equal '', msg.line
|
158
|
+
|
159
|
+
msg = log_add Logger::INFO, 'info level message'
|
160
|
+
assert_equal '', msg.line
|
161
|
+
|
162
|
+
msg = log_add Logger::DEBUG, 'debug level message'
|
163
|
+
assert_equal '', msg.line
|
164
|
+
end
|
165
|
+
|
166
|
+
def test_add_level_warn
|
167
|
+
@logger.level = Logger::WARN
|
168
|
+
|
169
|
+
msg = log_add nil, 'unknown level message' # nil == unknown
|
170
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
171
|
+
|
172
|
+
msg = log_add Logger::FATAL, 'fatal level message'
|
173
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
174
|
+
|
175
|
+
msg = log_add Logger::ERROR, 'error level message'
|
176
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
177
|
+
|
178
|
+
msg = log_add Logger::WARN, 'warn level message'
|
179
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
180
|
+
|
181
|
+
msg = log_add Logger::INFO, 'info level message'
|
182
|
+
assert_equal '', msg.line
|
183
|
+
|
184
|
+
msg = log_add Logger::DEBUG, 'debug level message'
|
185
|
+
assert_equal '', msg.line
|
186
|
+
end
|
187
|
+
|
188
|
+
def test_add_level_info
|
189
|
+
@logger.level = Logger::INFO
|
190
|
+
|
191
|
+
msg = log_add nil, 'unknown level message' # nil == unknown
|
192
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
193
|
+
|
194
|
+
msg = log_add Logger::FATAL, 'fatal level message'
|
195
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
196
|
+
|
197
|
+
msg = log_add Logger::ERROR, 'error level message'
|
198
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
199
|
+
|
200
|
+
msg = log_add Logger::WARN, 'warn level message'
|
201
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
202
|
+
|
203
|
+
msg = log_add Logger::INFO, 'info level message'
|
204
|
+
assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
|
205
|
+
|
206
|
+
msg = log_add Logger::DEBUG, 'debug level message'
|
207
|
+
assert_equal '', msg.line
|
208
|
+
end
|
209
|
+
|
210
|
+
def test_add_level_debug
|
211
|
+
@logger.level = Logger::DEBUG
|
212
|
+
|
213
|
+
msg = log_add nil, 'unknown level message' # nil == unknown
|
214
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
215
|
+
|
216
|
+
msg = log_add Logger::FATAL, 'fatal level message'
|
217
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
218
|
+
|
219
|
+
msg = log_add Logger::ERROR, 'error level message'
|
220
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
221
|
+
|
222
|
+
msg = log_add Logger::WARN, 'warn level message'
|
223
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
224
|
+
|
225
|
+
msg = log_add Logger::INFO, 'info level message'
|
226
|
+
assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
|
227
|
+
|
228
|
+
msg = log_add Logger::DEBUG, 'debug level message'
|
229
|
+
assert_equal LEVEL_LABEL_MAP[Logger::DEBUG], msg.severity
|
230
|
+
end
|
231
|
+
|
232
|
+
def test_unknown
|
233
|
+
msg = log :unknown, 'unknown level message'
|
234
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
235
|
+
|
236
|
+
@logger.level = Logger::UNKNOWN
|
237
|
+
msg = log :unknown, 'unknown level message'
|
238
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
239
|
+
|
240
|
+
@logger.level = Logger::FATAL
|
241
|
+
msg = log :unknown, 'unknown level message'
|
242
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
243
|
+
|
244
|
+
@logger.level = Logger::ERROR
|
245
|
+
msg = log :unknown, 'unknown level message'
|
246
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
247
|
+
|
248
|
+
@logger.level = Logger::WARN
|
249
|
+
msg = log :unknown, 'unknown level message'
|
250
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
251
|
+
|
252
|
+
@logger.level = Logger::INFO
|
253
|
+
msg = log :unknown, 'unknown level message'
|
254
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
255
|
+
|
256
|
+
@logger.level = Logger::DEBUG
|
257
|
+
msg = log :unknown, 'unknown level message'
|
258
|
+
assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
|
259
|
+
end
|
260
|
+
|
261
|
+
def test_unknown_eh
|
262
|
+
@logger.level = Logger::UNKNOWN
|
263
|
+
assert_equal true, @logger.unknown?
|
264
|
+
|
265
|
+
@logger.level = Logger::UNKNOWN + 1
|
266
|
+
assert_equal false, @logger.unknown?
|
267
|
+
end
|
268
|
+
|
269
|
+
def test_fatal
|
270
|
+
msg = log :fatal, 'fatal level message'
|
271
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
272
|
+
|
273
|
+
@logger.level = Logger::UNKNOWN
|
274
|
+
msg = log :fatal, 'fatal level message'
|
275
|
+
assert_equal '', msg.line
|
276
|
+
|
277
|
+
@logger.level = Logger::FATAL
|
278
|
+
msg = log :fatal, 'fatal level message'
|
279
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
280
|
+
|
281
|
+
@logger.level = Logger::ERROR
|
282
|
+
msg = log :fatal, 'fatal level message'
|
283
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
284
|
+
|
285
|
+
@logger.level = Logger::WARN
|
286
|
+
msg = log :fatal, 'fatal level message'
|
287
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
288
|
+
|
289
|
+
@logger.level = Logger::INFO
|
290
|
+
msg = log :fatal, 'fatal level message'
|
291
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
292
|
+
|
293
|
+
@logger.level = Logger::DEBUG
|
294
|
+
msg = log :fatal, 'fatal level message'
|
295
|
+
assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
|
296
|
+
end
|
297
|
+
|
298
|
+
def test_fatal_eh
|
299
|
+
@logger.level = Logger::FATAL
|
300
|
+
assert_equal true, @logger.fatal?
|
301
|
+
|
302
|
+
@logger.level = Logger::UNKNOWN
|
303
|
+
assert_equal false, @logger.fatal?
|
304
|
+
end
|
305
|
+
|
306
|
+
def test_error
|
307
|
+
msg = log :error, 'error level message'
|
308
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
309
|
+
|
310
|
+
@logger.level = Logger::UNKNOWN
|
311
|
+
msg = log :error, 'error level message'
|
312
|
+
assert_equal '', msg.line
|
313
|
+
|
314
|
+
@logger.level = Logger::FATAL
|
315
|
+
msg = log :error, 'error level message'
|
316
|
+
assert_equal '', msg.line
|
317
|
+
|
318
|
+
@logger.level = Logger::ERROR
|
319
|
+
msg = log :error, 'error level message'
|
320
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
321
|
+
|
322
|
+
@logger.level = Logger::WARN
|
323
|
+
msg = log :error, 'error level message'
|
324
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
325
|
+
|
326
|
+
@logger.level = Logger::INFO
|
327
|
+
msg = log :error, 'error level message'
|
328
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
329
|
+
|
330
|
+
@logger.level = Logger::DEBUG
|
331
|
+
msg = log :error, 'error level message'
|
332
|
+
assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
|
333
|
+
end
|
334
|
+
|
335
|
+
def test_error_eh
|
336
|
+
@logger.level = Logger::ERROR
|
337
|
+
assert_equal true, @logger.error?
|
338
|
+
|
339
|
+
@logger.level = Logger::FATAL
|
340
|
+
assert_equal false, @logger.error?
|
341
|
+
end
|
342
|
+
|
343
|
+
def test_warn
|
344
|
+
msg = log :warn, 'warn level message'
|
345
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
346
|
+
|
347
|
+
@logger.level = Logger::UNKNOWN
|
348
|
+
msg = log :warn, 'warn level message'
|
349
|
+
assert_equal '', msg.line
|
350
|
+
|
351
|
+
@logger.level = Logger::FATAL
|
352
|
+
msg = log :warn, 'warn level message'
|
353
|
+
assert_equal '', msg.line
|
354
|
+
|
355
|
+
@logger.level = Logger::ERROR
|
356
|
+
msg = log :warn, 'warn level message'
|
357
|
+
assert_equal '', msg.line
|
358
|
+
|
359
|
+
@logger.level = Logger::WARN
|
360
|
+
msg = log :warn, 'warn level message'
|
361
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
362
|
+
|
363
|
+
@logger.level = Logger::INFO
|
364
|
+
msg = log :warn, 'warn level message'
|
365
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
366
|
+
|
367
|
+
@logger.level = Logger::DEBUG
|
368
|
+
msg = log :warn, 'warn level message'
|
369
|
+
assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
|
370
|
+
end
|
371
|
+
|
372
|
+
def test_warn_eh
|
373
|
+
@logger.level = Logger::WARN
|
374
|
+
assert_equal true, @logger.warn?
|
375
|
+
|
376
|
+
@logger.level = Logger::ERROR
|
377
|
+
assert_equal false, @logger.warn?
|
378
|
+
end
|
379
|
+
|
380
|
+
def test_info
|
381
|
+
msg = log :info, 'info level message'
|
382
|
+
assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
|
383
|
+
|
384
|
+
@logger.level = Logger::UNKNOWN
|
385
|
+
msg = log :info, 'info level message'
|
386
|
+
assert_equal '', msg.line
|
387
|
+
|
388
|
+
@logger.level = Logger::FATAL
|
389
|
+
msg = log :info, 'info level message'
|
390
|
+
assert_equal '', msg.line
|
391
|
+
|
392
|
+
@logger.level = Logger::ERROR
|
393
|
+
msg = log :info, 'info level message'
|
394
|
+
assert_equal '', msg.line
|
395
|
+
|
396
|
+
@logger.level = Logger::WARN
|
397
|
+
msg = log :info, 'info level message'
|
398
|
+
assert_equal '', msg.line
|
399
|
+
|
400
|
+
@logger.level = Logger::INFO
|
401
|
+
msg = log :info, 'info level message'
|
402
|
+
assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
|
403
|
+
|
404
|
+
@logger.level = Logger::DEBUG
|
405
|
+
msg = log :info, 'info level message'
|
406
|
+
assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
|
407
|
+
end
|
408
|
+
|
409
|
+
def test_info_eh
|
410
|
+
@logger.level = Logger::INFO
|
411
|
+
assert_equal true, @logger.info?
|
412
|
+
|
413
|
+
@logger.level = Logger::WARN
|
414
|
+
assert_equal false, @logger.info?
|
415
|
+
end
|
416
|
+
|
417
|
+
def test_debug
|
418
|
+
msg = log :debug, 'debug level message'
|
419
|
+
assert_equal LEVEL_LABEL_MAP[Logger::DEBUG], msg.severity
|
420
|
+
|
421
|
+
@logger.level = Logger::UNKNOWN
|
422
|
+
msg = log :debug, 'debug level message'
|
423
|
+
assert_equal '', msg.line
|
424
|
+
|
425
|
+
@logger.level = Logger::FATAL
|
426
|
+
msg = log :debug, 'debug level message'
|
427
|
+
assert_equal '', msg.line
|
428
|
+
|
429
|
+
@logger.level = Logger::ERROR
|
430
|
+
msg = log :debug, 'debug level message'
|
431
|
+
assert_equal '', msg.line
|
432
|
+
|
433
|
+
@logger.level = Logger::WARN
|
434
|
+
msg = log :debug, 'debug level message'
|
435
|
+
assert_equal '', msg.line
|
436
|
+
|
437
|
+
@logger.level = Logger::INFO
|
438
|
+
msg = log :debug, 'debug level message'
|
439
|
+
assert_equal '', msg.line
|
440
|
+
|
441
|
+
@logger.level = Logger::DEBUG
|
442
|
+
msg = log :debug, 'debug level message'
|
443
|
+
assert_equal LEVEL_LABEL_MAP[Logger::DEBUG], msg.severity
|
444
|
+
end
|
445
|
+
|
446
|
+
def test_debug_eh
|
447
|
+
@logger.level = Logger::DEBUG
|
448
|
+
assert_equal true, @logger.debug?
|
449
|
+
|
450
|
+
@logger.level = Logger::INFO
|
451
|
+
assert_equal false, @logger.debug?
|
452
|
+
end
|
453
|
+
|
454
|
+
end
|
455
|
+
|
456
|
+
class TestSyslogLogger < TestLogger
|
457
|
+
|
458
|
+
def setup
|
459
|
+
super
|
460
|
+
@logger = SyslogLogger.new
|
461
|
+
end
|
462
|
+
|
463
|
+
class Log
|
464
|
+
attr_reader :line, :label, :datetime, :pid, :severity, :progname, :msg
|
465
|
+
def initialize(line)
|
466
|
+
@line = line
|
467
|
+
return unless /\A(\w+) - (.*)\Z/ =~ @line
|
468
|
+
severity, @msg = $1, $2
|
469
|
+
severity = SyslogLogger::LOGGER_MAP.invert[severity.downcase.intern]
|
470
|
+
@severity = severity.to_s.upcase
|
471
|
+
@severity = 'ANY' if @severity == 'UNKNOWN'
|
472
|
+
end
|
473
|
+
end
|
474
|
+
|
475
|
+
def log_add(severity, msg, progname = nil, &block)
|
476
|
+
log(:add, severity, msg, progname, &block)
|
477
|
+
end
|
478
|
+
|
479
|
+
def log(msg_id, *arg, &block)
|
480
|
+
Log.new(log_raw(msg_id, *arg, &block))
|
481
|
+
end
|
482
|
+
|
483
|
+
def log_raw(msg_id, *arg, &block)
|
484
|
+
assert_equal true, @logger.__send__(msg_id, *arg, &block)
|
485
|
+
msg = MockSyslog.line
|
486
|
+
MockSyslog.reset
|
487
|
+
return msg
|
488
|
+
end
|
489
|
+
|
490
|
+
end
|
491
|
+
|
metadata
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: cpowell-SyslogLogger
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.4.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Eric Hodel; Chris Powell
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2008-11-12 00:00:00 -08:00
|
13
|
+
default_executable:
|
14
|
+
dependencies: []
|
15
|
+
|
16
|
+
description: An improved Logger replacement that logs to syslog. It is almost drop-in with a few caveats.
|
17
|
+
email: drbrain@segment7.net; cpowell@prylis.com
|
18
|
+
executables: []
|
19
|
+
|
20
|
+
extensions: []
|
21
|
+
|
22
|
+
extra_rdoc_files:
|
23
|
+
- lib/analyzer_tools/syslog_logger.rb
|
24
|
+
- lib/syslog_logger.rb
|
25
|
+
- README.rdoc
|
26
|
+
files:
|
27
|
+
- History.txt
|
28
|
+
- lib/analyzer_tools/syslog_logger.rb
|
29
|
+
- lib/syslog_logger.rb
|
30
|
+
- Manifest
|
31
|
+
- Rakefile
|
32
|
+
- README.rdoc
|
33
|
+
- sysloglogger.gemspec
|
34
|
+
- test/test_syslog_logger.rb
|
35
|
+
- SyslogLogger.gemspec
|
36
|
+
has_rdoc: true
|
37
|
+
homepage: http://github.com/cpowell/sysloglogger
|
38
|
+
post_install_message:
|
39
|
+
rdoc_options:
|
40
|
+
- --line-numbers
|
41
|
+
- --inline-source
|
42
|
+
- --title
|
43
|
+
- SyslogLogger
|
44
|
+
- --main
|
45
|
+
- README.rdoc
|
46
|
+
require_paths:
|
47
|
+
- lib
|
48
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
49
|
+
requirements:
|
50
|
+
- - ">="
|
51
|
+
- !ruby/object:Gem::Version
|
52
|
+
version: "0"
|
53
|
+
version:
|
54
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
55
|
+
requirements:
|
56
|
+
- - ">="
|
57
|
+
- !ruby/object:Gem::Version
|
58
|
+
version: "1.2"
|
59
|
+
version:
|
60
|
+
requirements: []
|
61
|
+
|
62
|
+
rubyforge_project: sysloglogger
|
63
|
+
rubygems_version: 1.2.0
|
64
|
+
signing_key:
|
65
|
+
specification_version: 2
|
66
|
+
summary: An improved Logger replacement that logs to syslog. It is almost drop-in with a few caveats.
|
67
|
+
test_files:
|
68
|
+
- test/test_syslog_logger.rb
|