Sys::Syslog - Perl interface to the UNIX syslog(3) calls
use Sys::Syslog; # all except setlogsock, or: use Sys::Syslog qw(:DEFAULT setlogsock); # default set, plus setlogsock setlogsock $sock_type; openlog $ident, $logopt, $facility; # don't forget this syslog $priority, $format, @args; $oldmask = setlogmask $mask_priority; closelog;
Sys::Syslog is an interface to the UNIX
syslog(3) program. Call
syslog() with a string priority and a list of
printf() args just like
Syslog provides the functions:
- openlog $ident, $logopt, $facility
Opens the syslog. $ident is prepended to every message. $logopt contains zero or more of the words pid, ndelay, nowait. The cons option is ignored, since the failover mechanism will drop down to the console automatically if all other media fail. $facility specifies the part of the system to report about, for example LOG_USER or LOG_LOCAL0: see your
syslog(3)documentation for the facilities available in your system. This function will croak if it can't connect to the syslog daemon.
You should use openlog() before calling syslog().
- syslog $priority, $message
- syslog $priority, $format, @args
If $priority permits, logs $message or sprintf($format, @args) with the addition that %m in $message or $format is replaced with
"$!"(the latest error message).
If you didn't use openlog() before using syslog(), syslog will try to guess the $ident by extracting the shortest prefix of $format that ends in a ":".
Note that Sys::Syslog version v0.07 and older passed the $message as the formatting string to sprintf() even when no formatting arguments were provided. If the code calling syslog() might execute with older versions of this module, make sure to call the function as syslog($priority, "%s", $message) instead of syslog($priority, $message). This protects against hostile formatting sequences that might show up if $message contains tainted data.
- setlogmask $mask_priority
Sets log mask $mask_priority and returns the old mask.
- setlogsock $sock_type [$stream_location] (added in 5.004_02)
Sets the socket type to be used for the next call to
syslog()and returns TRUE on success, undef on failure.
A value of 'unix' will connect to the UNIX domain socket (in some systems a character special device) returned by the
_PATH_LOGmacro (if your system defines it), or /dev/log or /dev/conslog, whatever is writable. A value of 'stream' will connect to the stream indicated by the pathname provided as the optional second parameter. (For example Solaris and IRIX require 'stream' instead of 'unix'.) A value of 'inet' will connect to an INET socket (either tcp or udp, tried in that order) returned by getservbyname(). 'tcp' and 'udp' can also be given as values. The value 'console' will send messages directly to the console, as for the 'cons' option in the logopts in openlog().
A reference to an array can also be passed as the first parameter. When this calling method is used, the array should contain a list of sock_types which are attempted in order.
The default is to try tcp, udp, unix, stream, console.
Giving an invalid value for sock_type will croak.
Closes the log file.
openlog now takes three arguments, just like
openlog($program, 'cons,pid', 'user'); syslog('info', '%s', 'this is another test'); syslog('mail|warning', 'this is a better test: %d', time); closelog(); syslog('debug', 'this is the last test'); setlogsock('unix'); openlog("$program $$", 'ndelay', 'user'); syslog('notice', 'fooprogram: this is really done'); setlogsock('inet'); $! = 55; syslog('info', 'problem was %m'); # %m == $! in syslog(3) # Log to UDP port on $remotehost instead of logging locally setlogsock('udp'); $Sys::Syslog::host = $remotehost; openlog($program, 'ndelay', 'user'); syslog('info', 'something happened over here');
Tom Christiansen <email@example.com> and Larry Wall <firstname.lastname@example.org>.
UNIX domain sockets added by Sean Robinson <email@example.com> with support from Tim Bunce <Tim.Bunce@ig.co.uk> and the perl5-porters mailing list.
Dependency on syslog.ph replaced with XS code by Tom Hughes <firstname.lastname@example.org>.
Code for constant()s regenerated by Nicholas Clark <email@example.com>.
Failover to different communication modes by Nick Williams <Nick.Williams@morganstanley.com>.
Please report any bugs or feature requests to
bug-sys-syslog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sys-Syslog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
RT: CPAN's request tracker
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.