1 package OpenSRF::Utils::Logger;
3 use vars qw($AUTOLOAD @EXPORT_OK %EXPORT_TAGS);
5 use Unix::Syslog qw(:macros :subs);
6 use base qw/OpenSRF Exporter/;
8 use Time::HiRes qw(gettimeofday);
9 use OpenSRF::Utils::Config;
16 my $logger = OpenSRF::Utils::Logger;
17 $logger->error( $msg );
19 For backwards compability, a log level may also be provided to each log
20 function thereby overriding the level defined by the function.
22 i.e. $logger->error( $msg, WARN ); # logs at log level WARN
26 @EXPORT_OK = qw/ NONE ERROR WARN INFO DEBUG INTERNAL /;
27 push @EXPORT_OK, '$logger';
29 %EXPORT_TAGS = ( level => [ qw/ NONE ERROR WARN INFO DEBUG INTERNAL / ], logger => [ '$logger' ] );
31 my $config; # config handle
32 my $loglevel; # global log level
33 my $logfile; # log file
34 my $facility; # syslog facility
35 my $actfac; # activity log syslog facility
36 my $actfile; # activity log file
37 my $service = $0; # default service name
38 my $syslog_enabled = 0; # is syslog enabled?
39 my $act_syslog_enabled = 0; # is syslog enabled?
40 my $logfile_enabled = 1; # are we logging to a file?
41 my $act_logfile_enabled = 1; # are we logging to a file?
43 our $logger = "OpenSRF::Utils::Logger";
46 sub ACTIVITY { return -1; }
47 sub NONE { return 0; }
48 sub ERROR { return 1; }
49 sub WARN { return 2; }
50 sub INFO { return 3; }
51 sub DEBUG { return 4; }
52 sub INTERNAL { return 5; }
53 sub ALL { return 100; }
55 my $isclient; # true if we control the osrf_xid
57 # load up our config options
60 return if defined $config;
62 $config = OpenSRF::Utils::Config->current;
63 if( !defined($config) ) {
65 warn "*** Logger found no config. Using STDERR ***\n";
68 $loglevel = $config->bootstrap->loglevel;
69 if($loglevel = 1){ $loglevel = ERROR(); }
70 elsif($loglevel = 2){ $loglevel = WARN(); }
71 elsif($loglevel = 3){ $loglevel = INFO(); }
72 elsif($loglevel = 4){ $loglevel = DEBUG(); }
73 elsif($loglevel = 5){ $loglevel = INTERNAL(); }
74 else{$loglevel= INFO(); }
76 $logfile = $config->bootstrap->logfile;
77 if($logfile =~ /^syslog/) {
80 $logfile =~ s/^syslog:?//;
83 $facility = _fac_to_const($facility);
84 openlog($service, 0, $facility);
86 } else { $logfile = "$logfile"; }
88 $actfile = $config->bootstrap->actlog;
89 if($actfile =~ /^syslog/) {
90 $act_syslog_enabled = 1;
91 $act_logfile_enabled = 0;
92 $actfile =~ s/^syslog:?//;
93 $actfac = $actfile || "local1";
95 $actfac = _fac_to_const($actfac);
97 } else { $actfile = "$actfile"; }
99 $isclient = (OpenSRF::Utils::Config->current->bootstrap->client =~ /^true$/iog) ? 1 : 0;
104 return LOG_LOCAL0 unless $name;
105 return LOG_LOCAL0 if $name =~ /local0/i;
106 return LOG_LOCAL1 if $name =~ /local1/i;
107 return LOG_LOCAL2 if $name =~ /local2/i;
108 return LOG_LOCAL3 if $name =~ /local3/i;
109 return LOG_LOCAL4 if $name =~ /local4/i;
110 return LOG_LOCAL5 if $name =~ /local5/i;
111 return LOG_LOCAL6 if $name =~ /local6/i;
112 return LOG_LOCAL7 if $name =~ /local7/i;
118 return $syslog_enabled;
123 return $act_syslog_enabled;
128 return $logfile_enabled;
133 return $act_logfile_enabled;
137 my( $self, $svc ) = @_;
141 openlog($service, 0, $facility);
146 my( $self, $msg, $level ) = @_;
147 $level = ERROR() unless defined ($level);
148 _log_message( $msg, $level );
152 my( $self, $msg, $level ) = @_;
153 $level = WARN() unless defined ($level);
154 _log_message( $msg, $level );
158 my( $self, $msg, $level ) = @_;
159 $level = INFO() unless defined ($level);
160 _log_message( $msg, $level );
164 my( $self, $msg, $level ) = @_;
165 $level = DEBUG() unless defined ($level);
166 _log_message( $msg, $level );
170 my( $self, $msg, $level ) = @_;
171 $level = INTERNAL() unless defined ($level);
172 _log_message( $msg, $level );
176 my( $self, $msg ) = @_;
177 _log_message( $msg, ACTIVITY() );
180 # for backward compability
182 my( $self, $msg, $level ) = @_;
183 $level = DEBUG() unless defined ($level);
184 _log_message( $msg, $level );
188 # ----------------------------------------------------------------------
189 # creates a new xid if necessary
190 # ----------------------------------------------------------------------
192 my $osrf_xid_inc = 0;
194 return unless $isclient;
196 return $osrf_xid = "$^T${$}$osrf_xid_inc";
200 return if $isclient; # if we're a client, we control our xid
204 sub get_osrf_xid { return $osrf_xid; }
205 # ----------------------------------------------------------------------
209 my( $msg, $level ) = @_;
210 return if $level > $loglevel;
215 if ($level == ERROR()) {$l = LOG_ERR; $n = "ERR "; }
216 elsif ($level == WARN()) {$l = LOG_WARNING; $n = "WARN"; }
217 elsif ($level == INFO()) {$l = LOG_INFO; $n = "INFO"; }
218 elsif ($level == DEBUG()) {$l = LOG_DEBUG; $n = "DEBG"; }
219 elsif ($level == INTERNAL()) {$l = LOG_DEBUG; $n = "INTL"; }
220 elsif ($level == ACTIVITY()) {$l = LOG_INFO; $n = "ACT"; $fac = $actfac; }
222 my( undef, $file, $line_no ) = caller(1);
225 # help syslog with the formatting
226 $msg =~ s/\%/\%\%/gso if( is_act_syslog() or is_syslog() );
228 $msg = "[$n:"."$$".":$file:$line_no:$osrf_xid] $msg";
230 $msg = substr($msg, 0, 1536);
232 if( $level == ACTIVITY() ) {
233 if( is_act_syslog() ) { syslog( $fac | $l, $msg ); }
234 elsif( is_act_filelog() ) { _write_file( $msg, 1 ); }
237 if( is_syslog() ) { syslog( $fac | $l, $msg ); }
238 elsif( is_filelog() ) { _write_file($msg); }
244 my( $msg, $isact) = @_;
246 $file = $actfile if $isact;
247 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
248 $year += 1900; $mon += 1;
249 sysopen( SINK, $file, O_NONBLOCK|O_WRONLY|O_APPEND|O_CREAT )
250 or die "Cannot sysopen $logfile: $!";
251 binmode(SINK, ':utf8');
252 print SINK "[$year-$mon-$mday $hour:$min:$sec] $service $msg\n";