mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
35ca7f1087
Remove duplication of information Use standard markup Remove personalization --------- Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
152 lines
4.0 KiB
XML
152 lines
4.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.syslog" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>syslog</refname>
|
|
<refpurpose>Generate a system log message</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>true</type><methodname>syslog</methodname>
|
|
<methodparam><type>int</type><parameter>priority</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>message</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>syslog</function> generates a log message that will be
|
|
distributed by the system logger.
|
|
</para>
|
|
<para>
|
|
For information on setting up a user defined log handler, see the
|
|
<citerefentry><refentrytitle>syslog.conf</refentrytitle>
|
|
<manvolnum>5</manvolnum></citerefentry> Unix manual page. More
|
|
information on the syslog facilities and option can be found in the man
|
|
pages for <citerefentry><refentrytitle>syslog</refentrytitle>
|
|
<manvolnum>3</manvolnum></citerefentry> on Unix machines.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>priority</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of the
|
|
<simplelist type="inline">
|
|
<member><constant>LOG_EMERG</constant></member>
|
|
<member><constant>LOG_ALERT</constant></member>
|
|
<member><constant>LOG_CRIT</constant></member>
|
|
<member><constant>LOG_ERR</constant></member>
|
|
<member><constant>LOG_WARNING</constant></member>
|
|
<member><constant>LOG_NOTICE</constant></member>
|
|
<member><constant>LOG_INFO</constant></member>
|
|
<member><constant>LOG_DEBUG</constant></member>
|
|
</simplelist>
|
|
constants.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>message</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The message to send.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.true.always;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Using <function>syslog</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// open syslog, include the process ID and also send
|
|
// the log to standard error, and use a user defined
|
|
// logging mechanism
|
|
openlog("myScriptLog", LOG_PID | LOG_PERROR, LOG_LOCAL0);
|
|
|
|
// some code
|
|
|
|
if (authorized_client()) {
|
|
// do something
|
|
} else {
|
|
// unauthorized client!
|
|
// log the attempt
|
|
$access = date("Y/m/d H:i:s");
|
|
syslog(LOG_WARNING, "Unauthorized client: $access {$_SERVER['REMOTE_ADDR']} ({$_SERVER['HTTP_USER_AGENT']})");
|
|
}
|
|
|
|
closelog();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<para>
|
|
On Windows, the syslog service is emulated using the Event
|
|
Log.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Use of <constant>LOG_LOCAL0</constant> through
|
|
<literal>LOG_LOCAL7</literal> for the <parameter>facility</parameter>
|
|
parameter of <function>openlog</function> is not available
|
|
in Windows.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>openlog</function></member>
|
|
<member><function>closelog</function></member>
|
|
<member><link linkend="ini.syslog.filter">syslog.filter</link> INI setting (starting with PHP 7.3)</member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|