1 package OpenSRF::Utils::Logger;
4 use vars qw($AUTOLOAD @EXPORT_OK %EXPORT_TAGS);
6 use Unix::Syslog qw(:macros :subs);
7 use base qw/OpenSRF Exporter/;
9 use Time::HiRes qw(gettimeofday);
10 use OpenSRF::Utils::Config;
17 my $logger = OpenSRF::Utils::Logger;
18 $logger->error( $msg );
20 For backwards compability, a log level may also be provided to each log
21 function thereby overriding the level defined by the function.
23 i.e. $logger->error( $msg, WARN ); # logs at log level WARN
27 @EXPORT_OK = qw/ NONE ERROR WARN INFO DEBUG INTERNAL /;
28 push @EXPORT_OK, '$logger';
30 %EXPORT_TAGS = ( level => [ qw/ NONE ERROR WARN INFO DEBUG INTERNAL / ], logger => [ '$logger' ] );
32 my $config; # config handle
33 my $loglevel = INFO(); # global log level
34 my $logfile; # log file
35 my $facility; # syslog facility
36 my $actfac; # activity log syslog facility
37 my $actfile; # activity log file
38 my $service = $0; # default service name
39 my $syslog_enabled = 0; # is syslog enabled?
40 my $act_syslog_enabled = 0; # is syslog enabled?
41 my $logfile_enabled = 1; # are we logging to a file?
42 my $act_logfile_enabled = 1; # are we logging to a file?
43 my $max_log_msg_len = 1536; # SYSLOG default maximum is 2048
45 our $logger = "OpenSRF::Utils::Logger";
48 sub ACTIVITY { return -1; }
49 sub NONE { return 0; }
50 sub ERROR { return 1; }
51 sub WARN { return 2; }
52 sub INFO { return 3; }
53 sub DEBUG { return 4; }
54 sub INTERNAL { return 5; }
55 sub ALL { return 100; }
57 my $isclient; # true if we control the osrf_xid
59 # load up our config options
62 return if defined $config;
64 $config = OpenSRF::Utils::Config->current;
65 if( !defined($config) ) {
67 warn "*** Logger found no config. Using STDERR ***\n";
71 $loglevel = $config->bootstrap->loglevel;
73 if ($config->bootstrap->loglength) {
74 $max_log_msg_len = $config->bootstrap->loglength;
77 $logfile = $config->bootstrap->logfile;
78 if($logfile =~ /^syslog/) {
81 $logfile = $config->bootstrap->syslog;
84 $facility = _fac_to_const($facility);
85 openlog($service, 0, $facility);
87 } else { $logfile = "$logfile"; }
91 # --------------------------------------------------------------
92 # if we're syslogging, see if we have a special syslog facility
93 # for activity logging. If not, use the syslog facility for
95 # --------------------------------------------------------------
96 $act_syslog_enabled = 1;
97 $act_logfile_enabled = 0;
98 $actfac = $config->bootstrap->actlog || $config->bootstrap->syslog;
99 $actfac = _fac_to_const($actfac);
102 # --------------------------------------------------------------
103 # we're not syslogging, use any specified activity log file.
104 # Fall back to the standard log file otherwise
105 # --------------------------------------------------------------
106 $act_syslog_enabled = 0;
107 $act_logfile_enabled = 1;
108 $actfile = $config->bootstrap->actlog || $config->bootstrap->logfile;
111 my $client = OpenSRF::Utils::Config->current->bootstrap->client();
113 if ($ENV{OSRF_LOG_CLIENT} or $ENV{MOD_PERL}) {
122 $isclient = ($client =~ /^true$/iog) ? 1 : 0;
127 return LOG_LOCAL0 unless $name;
128 return LOG_LOCAL0 if $name =~ /local0/i;
129 return LOG_LOCAL1 if $name =~ /local1/i;
130 return LOG_LOCAL2 if $name =~ /local2/i;
131 return LOG_LOCAL3 if $name =~ /local3/i;
132 return LOG_LOCAL4 if $name =~ /local4/i;
133 return LOG_LOCAL5 if $name =~ /local5/i;
134 return LOG_LOCAL6 if $name =~ /local6/i;
135 return LOG_LOCAL7 if $name =~ /local7/i;
141 return $syslog_enabled;
146 return $act_syslog_enabled;
151 return $logfile_enabled;
156 return $act_logfile_enabled;
160 my( $self, $svc ) = @_;
164 openlog($service, 0, $facility);
169 my( $self, $msg, $level ) = @_;
170 $level = ERROR() unless defined ($level);
171 _log_message( $msg, $level );
175 my( $self, $msg, $level ) = @_;
176 $level = WARN() unless defined ($level);
177 _log_message( $msg, $level );
181 my( $self, $msg, $level ) = @_;
182 $level = INFO() unless defined ($level);
183 _log_message( $msg, $level );
187 my( $self, $msg, $level ) = @_;
188 $level = DEBUG() unless defined ($level);
189 _log_message( $msg, $level );
193 my( $self, $msg, $level ) = @_;
194 $level = INTERNAL() unless defined ($level);
195 _log_message( $msg, $level );
199 my( $self, $msg ) = @_;
200 _log_message( $msg, ACTIVITY() );
203 # for backward compability
205 my( $self, $msg, $level ) = @_;
206 $level = DEBUG() unless defined ($level);
207 _log_message( $msg, $level );
211 # ----------------------------------------------------------------------
212 # creates a new xid if necessary
213 # ----------------------------------------------------------------------
215 my $osrf_xid_inc = 0;
217 return unless $isclient;
219 return $osrf_xid = "$^T${$}$osrf_xid_inc";
223 return if $isclient; # if we're a client, we control our xid
227 sub get_osrf_xid { return $osrf_xid; }
228 # ----------------------------------------------------------------------
232 my( $msg, $level ) = @_;
233 return if $level > $loglevel;
238 if ($level == ERROR()) {$l = LOG_ERR; $n = "ERR "; }
239 elsif ($level == WARN()) {$l = LOG_WARNING; $n = "WARN"; }
240 elsif ($level == INFO()) {$l = LOG_INFO; $n = "INFO"; }
241 elsif ($level == DEBUG()) {$l = LOG_DEBUG; $n = "DEBG"; }
242 elsif ($level == INTERNAL()) {$l = LOG_DEBUG; $n = "INTL"; }
243 elsif ($level == ACTIVITY()) {$l = LOG_INFO; $n = "ACT"; $fac = $actfac; }
245 my( undef, $file, $line_no ) = caller(1);
248 # help syslog with the formatting
249 $msg =~ s/\%/\%\%/gso if( is_act_syslog() or is_syslog() );
251 $msg = "[$n:"."$$".":$file:$line_no:$osrf_xid] $msg";
253 # Trim the message to the configured maximum log message length
254 $msg = substr($msg, 0, $max_log_msg_len);
256 if( $level == ACTIVITY() ) {
257 if( is_act_syslog() ) { syslog( $fac | $l, $msg ); }
258 elsif( is_act_filelog() ) { _write_file( $msg, 1 ); }
261 if( is_syslog() ) { syslog( $fac | $l, $msg ); }
262 elsif( is_filelog() ) { _write_file($msg); }
269 my ($msg, $isact) = @_;
270 my $file = $isact ? $actfile : $logfile;
271 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
272 $year += 1900; $mon += 1;
275 sysopen( SINK, $file, O_NONBLOCK|O_WRONLY|O_APPEND|O_CREAT )
276 or die "Cannot sysopen $file: $!";
278 open (SINK, ">&2"); # print to STDERR as warned
280 binmode(SINK, ':utf8');
281 printf SINK "[%04d-%02d-%02d %02d:%02d:%02d] %s %s\n", $year, $mon, $mday, $hour, $min, $sec, $service, $msg;