File: syslog.xml

package info (click to toggle)
php-doc 20250827~git.abe740d%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 71,968 kB
  • sloc: xml: 985,760; php: 25,504; javascript: 671; sh: 177; makefile: 37
file content (151 lines) | stat: -rw-r--r-- 4,104 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?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
-->