[GENERIC] Zend_Translate:
[zend.git] / documentation / manual / en / module_specs / Zend_Log-Writers-Syslog.xml
blobb13e053c9b23652634cec6274c9de89220917ef2
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- Reviewed: no -->
3 <sect2 id="zend.log.writers.syslog">
4     <title>Writing to the System Log</title>
6     <para>
7         <classname>Zend_Log_Writer_Syslog</classname> writes log entries to the
8         system log (syslog). Internally, it proxies to <acronym>PHP</acronym>'s
9         <methodname>openlog()</methodname>,
10         <methodname>closelog()</methodname>, and
11         <methodname>syslog()</methodname> functions.
12     </para>
14     <para>
15         One useful case for <classname>Zend_Log_Writer_Syslog</classname>
16         is for aggregating logs from clustered machines via the system log
17         functionality. Many systems allow remote logging of system events, which
18         allows system administrators to monitor a cluster of machines from a
19         single log file.
20     </para>
22     <para>
23         By default, all syslog messages generated are prefixed with the string
24         "Zend_Log". You may specify a different "application" name by which to
25         identify such log messages by either passing the application name to the
26         constructor or the application accessor:
27     </para>
29     <programlisting language="php"><![CDATA[
30 // At instantiation, pass the "application" key in the options:
31 $writer = new Zend_Log_Writer_Syslog(array('application' => 'FooBar'));
33 // Any other time:
34 $writer->setApplicationName('BarBaz');
35 ]]></programlisting>
37     <para>
38         The system log also allows you to identify the "facility," or
39         application type, logging the message; many system loggers will actually
40         generate different log files per facility, which again aids
41         administrators monitoring server activity.
42     </para>
44     <para>
45         You may specify the log facility either in the constructor or via an
46         accessor. It should be one of the <methodname>openlog()</methodname>
47         constants defined on the <ulink url="http://php.net/openlog">openlog()
48             manual page</ulink>.
49     </para>
51     <programlisting language="php"><![CDATA[
52 // At instantiation, pass the "facility" key in the options:
53 $writer = new Zend_Log_Writer_Syslog(array('facility' => LOG_AUTH));
55 // Any other time:
56 $writer->setFacility(LOG_USER);
57 ]]></programlisting>
59     <para>
60         When logging, you may continue to use the default
61         <classname>Zend_Log</classname> priority constants; internally, they are
62         mapped to the appropriate <methodname>syslog()</methodname> priority
63         constants.
64     </para>
65 </sect2>