{ "content": [ { "type": "text", "text": "# Sys::Syslog (perldoc)\n\n## NAME\n\nSys::Syslog - Perl interface to the UNIX syslog(3) calls\n\n## SYNOPSIS\n\nuse Sys::Syslog; # all except setlogsock()\nuse Sys::Syslog qw(:standard :macros); # standard functions & macros\nopenlog($ident, $logopt, $facility); # don't forget this\nsyslog($priority, $format, @args);\n$oldmask = setlogmask($maskpriority);\ncloselog();\n\n## DESCRIPTION\n\n\"Sys::Syslog\" is an interface to the UNIX syslog(3) program. Call syslog() with a string\npriority and a list of printf() args just like syslog(3).\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **EXPORTS**\n- **FUNCTIONS** (6 subsections)\n- **EXAMPLES**\n- **CONSTANTS** (2 subsections)\n- **DIAGNOSTICS**\n- **HISTORY**\n- **SEE ALSO** (5 subsections)\n- **BUGS**\n- **SUPPORT**\n- **COPYRIGHT**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "Sys::Syslog", "section": "", "mode": "perldoc", "summary": "Sys::Syslog - Perl interface to the UNIX syslog(3) calls", "synopsis": "use Sys::Syslog; # all except setlogsock()\nuse Sys::Syslog qw(:standard :macros); # standard functions & macros\nopenlog($ident, $logopt, $facility); # don't forget this\nsyslog($priority, $format, @args);\n$oldmask = setlogmask($maskpriority);\ncloselog();", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [ "An example:", "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');", "Another example:", "openlog(\"$program $$\", 'ndelay', 'user');", "syslog('notice', 'fooprogram: this is really done');", "Example of use of %m:", "$! = 55;", "syslog('info', 'problem was %m'); # %m == $! in syslog(3)", "Log to UDP port on $remotehost instead of logging locally:", "setlogsock(\"udp\", $remotehost);", "openlog($program, 'ndelay', 'user');", "syslog('info', 'something happened over here');" ], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 8, "subsections": [] }, { "name": "DESCRIPTION", "lines": 3, "subsections": [] }, { "name": "EXPORTS", "lines": 16, "subsections": [] }, { "name": "FUNCTIONS", "lines": 1, "subsections": [ { "name": "openlog", "lines": 48 }, { "name": "syslog", "lines": 1 }, { "name": "syslog", "lines": 29 }, { "name": "setlogmask", "lines": 25 }, { "name": "setlogsock", "lines": 96 }, { "name": "closelog", "lines": 21 } ] }, { "name": "EXAMPLES", "lines": 25, "subsections": [] }, { "name": "CONSTANTS", "lines": 1, "subsections": [ { "name": "Facilities", "lines": 46 }, { "name": "Levels", "lines": 16 } ] }, { "name": "DIAGNOSTICS", "lines": 44, "subsections": [] }, { "name": "HISTORY", "lines": 22, "subsections": [] }, { "name": "SEE ALSO", "lines": 1, "subsections": [ { "name": "Other modules", "lines": 6 }, { "name": "Manual Pages", "lines": 1 }, { "name": "syslog", "lines": 34 }, { "name": "Articles", "lines": 2 }, { "name": "Event Log", "lines": 28 } ] }, { "name": "BUGS", "lines": 4, "subsections": [] }, { "name": "SUPPORT", "lines": 32, "subsections": [] }, { "name": "COPYRIGHT", "lines": 2, "subsections": [] }, { "name": "LICENSE", "lines": 3, "subsections": [] } ], "sections": { "NAME": { "content": "Sys::Syslog - Perl interface to the UNIX syslog(3) calls\n", "subsections": [] }, "VERSION": { "content": "This is the documentation of version 0.36\n", "subsections": [] }, "SYNOPSIS": { "content": "use Sys::Syslog; # all except setlogsock()\nuse Sys::Syslog qw(:standard :macros); # standard functions & macros\n\nopenlog($ident, $logopt, $facility); # don't forget this\nsyslog($priority, $format, @args);\n$oldmask = setlogmask($maskpriority);\ncloselog();\n", "subsections": [] }, "DESCRIPTION": { "content": "\"Sys::Syslog\" is an interface to the UNIX syslog(3) program. Call syslog() with a string\npriority and a list of printf() args just like syslog(3).\n", "subsections": [] }, "EXPORTS": { "content": "\"Sys::Syslog\" exports the following \"Exporter\" tags:\n\n* \":standard\" exports the standard syslog(3) functions:\n\nopenlog closelog setlogmask syslog\n\n* \":extended\" exports the Perl specific functions for syslog(3):\n\nsetlogsock\n\n* \":macros\" exports the symbols corresponding to most of your syslog(3) macros and the\nLOGUPTO() and LOGMASK() functions. See \"CONSTANTS\" for the supported constants and their\nmeaning.\n\nBy default, \"Sys::Syslog\" exports the symbols from the \":standard\" tag.\n", "subsections": [] }, "FUNCTIONS": { "content": "", "subsections": [ { "name": "openlog", "content": "Opens the syslog. $ident is prepended to every message. $logopt contains zero or more of the\noptions detailed below. $facility specifies the part of the system to report about, for\nexample \"LOGUSER\" or \"LOGLOCAL0\": see \"Facilities\" for a list of well-known facilities,\nand your syslog(3) documentation for the facilities available in your system. Check \"SEE\nALSO\" for useful links. Facility can be given as a string or a numeric macro.\n\nThis function will croak if it can't connect to the syslog daemon.\n\nNote that openlog() now takes three arguments, just like openlog(3).\n\nYou should use openlog() before calling syslog().\n\nOptions\n\n* \"cons\" - This option is ignored, since the failover mechanism will drop down to the\nconsole automatically if all other media fail.\n\n* \"ndelay\" - Open the connection immediately (normally, the connection is opened when the\nfirst message is logged).\n\n* \"noeol\" - When set to true, no end of line character (\"\\n\") will be appended to the\nmessage. This can be useful for some syslog daemons. Added in \"Sys::Syslog\" 0.29.\n\n* \"nofatal\" - When set to true, openlog() and syslog() will only emit warnings instead of\ndying if the connection to the syslog can't be established. Added in \"Sys::Syslog\" 0.15.\n\n* \"nonul\" - When set to true, no \"NUL\" character (\"\\0\") will be appended to the message.\nThis can be useful for some syslog daemons. Added in \"Sys::Syslog\" 0.29.\n\n* \"nowait\" - Don't wait for child processes that may have been created while logging the\nmessage. (The GNU C library does not create a child process, so this option has no\neffect on Linux.)\n\n* \"perror\" - Write the message to standard error output as well to the system log. Added\nin \"Sys::Syslog\" 0.22.\n\n* \"pid\" - Include PID with each message.\n\nExamples\n\nOpen the syslog with options \"ndelay\" and \"pid\", and with facility \"LOCAL0\":\n\nopenlog($name, \"ndelay,pid\", \"local0\");\n\nSame thing, but this time using the macro corresponding to \"LOCAL0\":\n\nopenlog($name, \"ndelay,pid\", LOGLOCAL0);\n" }, { "name": "syslog", "content": "" }, { "name": "syslog", "content": "If $priority permits, logs $message or \"sprintf($format, @args)\" with the addition that %m\nin $message or $format is replaced with \"$!\" (the latest error message).\n\n$priority can specify a level, or a level and a facility. Levels and facilities can be given\nas strings or as macros. When using the \"eventlog\" mechanism, priorities \"DEBUG\" and \"INFO\"\nare mapped to event type \"informational\", \"NOTICE\" and \"WARNING\" to \"warning\" and \"ERR\" to\n\"EMERG\" to \"error\".\n\nIf you didn't use openlog() before using syslog(), syslog() will try to guess the $ident by\nextracting the shortest prefix of $format that ends in a \":\".\n\nExamples\n\n# informational level\nsyslog(\"info\", $message);\nsyslog(LOGINFO, $message);\n\n# information level, Local0 facility\nsyslog(\"info|local0\", $message);\nsyslog(LOGINFO|LOGLOCAL0, $message);\n\nNote\n\"Sys::Syslog\" version v0.07 and older passed the $message as the formatting string to\nsprintf() even when no formatting arguments were provided. If the code calling syslog()\nmight execute with older versions of this module, make sure to call the function as\n\"syslog($priority, \"%s\", $message)\" instead of \"syslog($priority, $message)\". This\nprotects against hostile formatting sequences that might show up if $message contains\ntainted data.\n" }, { "name": "setlogmask", "content": "Sets the log mask for the current process to $maskpriority and returns the old mask. If the\nmask argument is 0, the current log mask is not modified. See \"Levels\" for the list of\navailable levels. You can use the LOGUPTO() function to allow all levels up to a given\npriority (but it only accept the numeric macros as arguments).\n\nExamples\n\nOnly log errors:\n\nsetlogmask( LOGMASK(LOGERR) );\n\nLog everything except informational messages:\n\nsetlogmask( ~(LOGMASK(LOGINFO)) );\n\nLog critical messages, errors and warnings:\n\nsetlogmask( LOGMASK(LOGCRIT)\n| LOGMASK(LOGERR)\n| LOGMASK(LOGWARNING) );\n\nLog all messages up to debug:\n\nsetlogmask( LOGUPTO(LOGDEBUG) );\n" }, { "name": "setlogsock", "content": "Sets the socket type and options to be used for the next call to openlog() or syslog().\nReturns true on success, \"undef\" on failure.\n\nBeing Perl-specific, this function has evolved along time. It can currently be called as\nfollow:\n\n* setlogsock($socktype)\n\n* \"setlogsock($socktype, $streamlocation)\" (added in Perl 5.00402)\n\n* \"setlogsock($socktype, $streamlocation, $socktimeout)\" (added in \"Sys::Syslog\" 0.25)\n\n* setlogsock(\\%options) (added in \"Sys::Syslog\" 0.28)\n\nThe available options are:\n\n* \"type\" - equivalent to $socktype, selects the socket type (or \"mechanism\"). An array\nreference can be passed to specify several mechanisms to try, in the given order.\n\n* \"path\" - equivalent to $streamlocation, sets the stream location. Defaults to standard\nUnix location, or \"PATHLOG\".\n\n* \"timeout\" - equivalent to $socktimeout, sets the socket timeout in seconds. Defaults to\n0 on all systems except Mac OS X where it is set to 0.25 sec.\n\n* \"host\" - sets the hostname to send the messages to. Defaults to the local host.\n\n* \"port\" - sets the TCP or UDP port to connect to. Defaults to the first standard syslog\nport available on the system.\n\nThe available mechanisms are:\n\n* \"native\" - use the native C functions from your syslog(3) library (added in\n\"Sys::Syslog\" 0.15).\n\n* \"eventlog\" - send messages to the Win32 events logger (Win32 only; added in\n\"Sys::Syslog\" 0.19).\n\n* \"tcp\" - connect to a TCP socket, on the \"syslog/tcp\" or \"syslogng/tcp\" service. See also\nthe \"host\", \"port\" and \"timeout\" options.\n\n* \"udp\" - connect to a UDP socket, on the \"syslog/udp\" service. See also the \"host\",\n\"port\" and \"timeout\" options.\n\n* \"inet\" - connect to an INET socket, either TCP or UDP, tried in that order. See also the\n\"host\", \"port\" and \"timeout\" options.\n\n* \"unix\" - connect to a UNIX domain socket (in some systems a character special device).\nThe name of that socket is given by the \"path\" option or, if omitted, the value returned\nby the \"PATHLOG\" macro (if your system defines it), /dev/log or /dev/conslog,\nwhichever is writable.\n\n* \"stream\" - connect to the stream indicated by the \"path\" option, or, if omitted, the\nvalue returned by the \"PATHLOG\" macro (if your system defines it), /dev/log or\n/dev/conslog, whichever is writable. For example Solaris and IRIX system may prefer\n\"stream\" instead of \"unix\".\n\n* \"pipe\" - connect to the named pipe indicated by the \"path\" option, or, if omitted, to\nthe value returned by the \"PATHLOG\" macro (if your system defines it), or /dev/log\n(added in \"Sys::Syslog\" 0.21). HP-UX is a system which uses such a named pipe.\n\n* \"console\" - send messages directly to the console, as for the \"cons\" option of\nopenlog().\n\nThe default is to try \"native\", \"tcp\", \"udp\", \"unix\", \"pipe\", \"stream\", \"console\". Under\nsystems with the Win32 API, \"eventlog\" will be added as the first mechanism to try if\n\"Win32::EventLog\" is available.\n\nGiving an invalid value for $socktype will \"croak\".\n\nExamples\n\nSelect the UDP socket mechanism:\n\nsetlogsock(\"udp\");\n\nSend messages using the TCP socket mechanism on a custom port:\n\nsetlogsock({ type => \"tcp\", port => 2486 });\n\nSend messages to a remote host using the TCP socket mechanism:\n\nsetlogsock({ type => \"tcp\", host => $loghost });\n\nTry the native, UDP socket then UNIX domain socket mechanisms:\n\nsetlogsock([\"native\", \"udp\", \"unix\"]);\n\nNote\nNow that the \"native\" mechanism is supported by \"Sys::Syslog\" and selected by default,\nthe use of the setlogsock() function is discouraged because other mechanisms are less\nportable across operating systems. Authors of modules and programs that use this\nfunction, especially its cargo-cult form setlogsock(\"unix\"), are advised to remove any\noccurrence of it unless they specifically want to use a given mechanism (like TCP or UDP\nto connect to a remote host).\n" }, { "name": "closelog", "content": "Closes the log file and returns true on success.\n\nTHE RULES OF SYS::SYSLOG\n*The First Rule of Sys::Syslog is:* You do not call \"setlogsock\".\n\n*The Second Rule of Sys::Syslog is:* You do not call \"setlogsock\".\n\n*The Third Rule of Sys::Syslog is:* The program crashes, \"die\"s, calls \"closelog\", the log is\nover.\n\n*The Fourth Rule of Sys::Syslog is:* One facility, one priority.\n\n*The Fifth Rule of Sys::Syslog is:* One log at a time.\n\n*The Sixth Rule of Sys::Syslog is:* No \"syslog\" before \"openlog\".\n\n*The Seventh Rule of Sys::Syslog is:* Logs will go on as long as they have to.\n\n*The Eighth, and Final Rule of Sys::Syslog is:* If this is your first use of Sys::Syslog, you\nmust read the doc.\n" } ] }, "EXAMPLES": { "content": "An example:\n\nopenlog($program, 'cons,pid', 'user');\nsyslog('info', '%s', 'this is another test');\nsyslog('mail|warning', 'this is a better test: %d', time);\ncloselog();\n\nsyslog('debug', 'this is the last test');\n\nAnother example:\n\nopenlog(\"$program $$\", 'ndelay', 'user');\nsyslog('notice', 'fooprogram: this is really done');\n\nExample of use of %m:\n\n$! = 55;\nsyslog('info', 'problem was %m'); # %m == $! in syslog(3)\n\nLog to UDP port on $remotehost instead of logging locally:\n\nsetlogsock(\"udp\", $remotehost);\nopenlog($program, 'ndelay', 'user');\nsyslog('info', 'something happened over here');\n", "subsections": [] }, "CONSTANTS": { "content": "", "subsections": [ { "name": "Facilities", "content": "* \"LOGAUDIT\" - audit daemon (IRIX); falls back to \"LOGAUTH\"\n\n* \"LOGAUTH\" - security/authorization messages\n\n* \"LOGAUTHPRIV\" - security/authorization messages (private)\n\n* \"LOGCONSOLE\" - \"/dev/console\" output (FreeBSD); falls back to \"LOGUSER\"\n\n* \"LOGCRON\" - clock daemons (cron and at)\n\n* \"LOGDAEMON\" - system daemons without separate facility value\n\n* \"LOGFTP\" - FTP daemon\n\n* \"LOGKERN\" - kernel messages\n\n* \"LOGINSTALL\" - installer subsystem (Mac OS X); falls back to \"LOGUSER\"\n\n* \"LOGLAUNCHD\" - launchd - general bootstrap daemon (Mac OS X); falls back to \"LOGDAEMON\"\n\n* \"LOGLFMT\" - logalert facility; falls back to \"LOGUSER\"\n\n* \"LOGLOCAL0\" through \"LOGLOCAL7\" - reserved for local use\n\n* \"LOGLPR\" - line printer subsystem\n\n* \"LOGMAIL\" - mail subsystem\n\n* \"LOGNETINFO\" - NetInfo subsystem (Mac OS X); falls back to \"LOGDAEMON\"\n\n* \"LOGNEWS\" - USENET news subsystem\n\n* \"LOGNTP\" - NTP subsystem (FreeBSD, NetBSD); falls back to \"LOGDAEMON\"\n\n* \"LOGRAS\" - Remote Access Service (VPN / PPP) (Mac OS X); falls back to \"LOGAUTH\"\n\n* \"LOGREMOTEAUTH\" - remote authentication/authorization (Mac OS X); falls back to \"LOGAUTH\"\n\n* \"LOGSECURITY\" - security subsystems (firewalling, etc.) (FreeBSD); falls back to \"LOGAUTH\"\n\n* \"LOGSYSLOG\" - messages generated internally by syslogd\n\n* \"LOGUSER\" (default) - generic user-level messages\n\n* \"LOGUUCP\" - UUCP subsystem\n" }, { "name": "Levels", "content": "* \"LOGEMERG\" - system is unusable\n\n* \"LOGALERT\" - action must be taken immediately\n\n* \"LOGCRIT\" - critical conditions\n\n* \"LOGERR\" - error conditions\n\n* \"LOGWARNING\" - warning conditions\n\n* \"LOGNOTICE\" - normal, but significant, condition\n\n* \"LOGINFO\" - informational message\n\n* \"LOGDEBUG\" - debug-level message\n" } ] }, "DIAGNOSTICS": { "content": "\"Invalid argument passed to setlogsock\"\n(F) You gave setlogsock() an invalid value for $socktype.\n\n\"eventlog passed to setlogsock, but no Win32 API available\"\n(W) You asked setlogsock() to use the Win32 event logger but the operating system running\nthe program isn't Win32 or does not provides Win32 compatible facilities.\n\n\"no connection to syslog available\"\n(F) syslog() failed to connect to the specified socket.\n\n\"stream passed to setlogsock, but %s is not writable\"\n(W) You asked setlogsock() to use a stream socket, but the given path is not writable.\n\n\"stream passed to setlogsock, but could not find any device\"\n(W) You asked setlogsock() to use a stream socket, but didn't provide a path, and\n\"Sys::Syslog\" was unable to find an appropriate one.\n\n\"tcp passed to setlogsock, but tcp service unavailable\"\n(W) You asked setlogsock() to use a TCP socket, but the service is not available on the\nsystem.\n\n\"syslog: expecting argument %s\"\n(F) You forgot to give syslog() the indicated argument.\n\n\"syslog: invalid level/facility: %s\"\n(F) You specified an invalid level or facility.\n\n\"syslog: too many levels given: %s\"\n(F) You specified too many levels.\n\n\"syslog: too many facilities given: %s\"\n(F) You specified too many facilities.\n\n\"syslog: level must be given\"\n(F) You forgot to specify a level.\n\n\"udp passed to setlogsock, but udp service unavailable\"\n(W) You asked setlogsock() to use a UDP socket, but the service is not available on the\nsystem.\n\n\"unix passed to setlogsock, but path not available\"\n(W) You asked setlogsock() to use a UNIX socket, but \"Sys::Syslog\" was unable to find an\nappropriate an appropriate device.\n", "subsections": [] }, "HISTORY": { "content": "\"Sys::Syslog\" is a core module, part of the standard Perl distribution since 1990. At this time,\nmodules as we know them didn't exist, the Perl library was a collection of .pl files, and the\none for sending syslog messages with was simply lib/syslog.pl, included with Perl 3.0. It was\nconverted as a module with Perl 5.0, but had a version number only starting with Perl 5.6. Here\nis a small table with the matching Perl and \"Sys::Syslog\" versions.\n\nSys::Syslog Perl\n----------- ----\nundef 5.0.0 ~ 5.5.4\n0.01 5.6.*\n0.03 5.8.0\n0.04 5.8.1, 5.8.2, 5.8.3\n0.05 5.8.4, 5.8.5, 5.8.6\n0.06 5.8.7\n0.13 5.8.8\n0.22 5.10.0\n0.27 5.8.9, 5.10.1 ~ 5.14.*\n0.29 5.16.*\n0.32 5.18.*\n0.33 5.20.*\n0.33 5.22.*\n", "subsections": [] }, "SEE ALSO": { "content": "", "subsections": [ { "name": "Other modules", "content": "Log::Log4perl - Perl implementation of the Log4j API\n\nLog::Dispatch - Dispatches messages to one or more outputs\n\nLog::Report - Report a problem, with exceptions and language support\n" }, { "name": "Manual Pages", "content": "" }, { "name": "syslog", "content": "SUSv3 issue 6, IEEE Std 1003.1, 2004 edition,\n\n\nGNU C Library documentation on syslog,\n\n\nFreeBSD documentation on syslog, \n\nSolaris 11 documentation on syslog,\n\n\nMac OS X documentation on syslog,\n\n\nIRIX documentation on syslog, \n\nAIX 5L 5.3 documentation on syslog,\n\n\nHP-UX 11i documentation on syslog, \n\nTru64 documentation on syslog, \n\nStratus VOS 15.1,\n\n\nRFCs\n*RFC 3164 - The BSD syslog Protocol*, -- Please note\nthat this is an informational RFC, and therefore does not specify a standard of any kind.\n\n*RFC 3195 - Reliable Delivery for syslog*, \n" }, { "name": "Articles", "content": "*Syslogging with Perl*, \n" }, { "name": "Event Log", "content": "Windows Event Log,\n\n\nAUTHORS & ACKNOWLEDGEMENTS\nTom Christiansen and Larry Wall .\n\nUNIX domain sockets added by Sean Robinson with support from\nTim Bunce and the \"perl5-porters\" mailing list.\n\nDependency on syslog.ph replaced with XS code by Tom Hughes .\n\nCode for constant()s regenerated by Nicholas Clark .\n\nFailover to different communication modes by Nick Williams .\n\nExtracted from core distribution for publishing on the CPAN by Sébastien Aperghis-Tramoni\n.\n\nXS code for using native C functions borrowed from \"Unix::Syslog\", written by Marcus Harnisch\n.\n\nYves Orton suggested and helped for making \"Sys::Syslog\" use the native event logger under Win32\nsystems.\n\nJerry D. Hedden and Reini Urban provided greatly appreciated help to debug and polish\n\"Sys::Syslog\" under Cygwin.\n" } ] }, "BUGS": { "content": "Please report any bugs or feature requests to \"bug-sys-syslog (at) rt.cpan.org\", or through the\nweb interface at . I will be\nnotified, and then you'll automatically be notified of progress on your bug as I make changes.\n", "subsections": [] }, "SUPPORT": { "content": "You can find documentation for this module with the perldoc command.\n\nperldoc Sys::Syslog\n\nYou can also look for information at:\n\n* Perl Documentation\n\n\n\n* MetaCPAN\n\n\n\n* Search CPAN\n\n\n\n* AnnoCPAN: Annotated CPAN documentation\n\n\n\n* CPAN Ratings\n\n\n\n* RT: CPAN's request tracker\n\n\n\nThe source code is available on Git Hub: \n", "subsections": [] }, "COPYRIGHT": { "content": "Copyright (C) 1990-2012 by Larry Wall and others.\n", "subsections": [] }, "LICENSE": { "content": "This program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n", "subsections": [] } } } }