1
0
mirror of https://github.com/php/doc-zh.git synced 2026-03-23 22:52:08 +01:00

seaslog : fix XML by converting para to simpara tags via script

This commit is contained in:
Gina Peter Banyard
2026-01-25 15:20:34 +00:00
parent 22fe4957ce
commit 74b2cf7dea
24 changed files with 311 additions and 333 deletions

View File

@@ -1,30 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 11f0c34a3deb40fa93a7458997c84d133820b815 Maintainer: neeke Status: ready -->
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: neeke Status: ready -->
<!-- CREDITS: Luffy -->
<book xml:id="book.seaslog" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.seaslog">
<?phpdoc extension-membership="pecl" ?>
<title>SeasLog</title>
<titleabbrev>SeasLog</titleabbrev>
<preface xml:id="intro.seaslog">
&reftitle.intro;
<para>
<simpara>
<acronym>SeasLog</acronym> 是一个高效、快速、稳定的 PHP 日志扩展。
</para>
<para>
</simpara>
<simpara>
Log 日志,通常是系统或软件、应用的运行记录。
通过 Log 的分析,可以方便用户了解系统或软件、应用的运行情况;
如果你的应用 Log 足够丰富,也可以分析以往用户的操作行为、类型喜好、地域分布或其他更多信息;
如果一个应用的 Log 同时也分了多个级别,那么可以很轻易地分析得到该应用的健康状况,
及时发现问题并快速定位、解决问题,补救损失。
</para>
<para>
</simpara>
<simpara>
PHP 内置 error_log、syslog 函数功能强大且性能极好,但由于各种缺陷(error_log 无错误级别、无固定格式syslog 不分模块、与系统日志混合),灵活度降低了很多,不能满足应用需求。
</para>
<para>
</simpara>
<simpara>
好消息是有不少第三方的log类库弥补了上述缺陷如 log4php、plog、monolog 等(当然也有很多应用在项目中自己开发的 Log 类)。
</para>
</simpara>
<para>
那么有没有一种 Log 类库满足以下需求呢:
<simplelist>
@@ -52,9 +52,9 @@
<member>支持日志模板自定义</member>
</simplelist>
</para>
<para>
<simpara>
从Github上获取更多文档 <link xlink:href="&url.seaslog.document;">SeasLog 文档</link>
</para>
</simpara>
</preface>
&reference.seaslog.setup;
@@ -64,7 +64,6 @@
&reference.seaslog.seaslog;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2810624ba419c2e3ddc9ff00a79b41f81f9f0f8f Maintainer: neeke Status: ready -->
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: neeke Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<chapter xml:id="seaslog.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.examples">
&reftitle.examples;
<example>
@@ -70,14 +70,14 @@ SeasLog::emergency('Just now, the house next door was completely burnt out! {not
?>
]]>
</programlisting>
<para>
<simpara>
日志的默认模板是 <emphasis>seaslog.default_template = "%T | %L | %P | %Q | %t | %M"</emphasis>.
这意味着,在默认情况下,日志的记录格式是: `{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}`.
</para>
</simpara>
&example.outputs.similar;
<para>
<simpara>
<emphasis>seaslog.appender = 1</emphasis>
</para>
</simpara>
<screen>
<![CDATA[
2014-07-27 08:53:52 | ERROR | 23625 | 599159975a9ff | 1406422432.786 | this is a error test by log
@@ -91,9 +91,9 @@ SeasLog::emergency('Just now, the house next door was completely burnt out! {not
]]>
</screen>
&example.outputs.similar;
<para>
<simpara>
<emphasis>seaslog.appender = 2</emphasis><emphasis>seaslog.appender = 3</emphasis>
</para>
</simpara>
<screen>
<![CDATA[
The log style finally formatted such as:
@@ -106,9 +106,9 @@ The log style finally formatted such as:
<example>
<title>快速获取某级别下日志的数量</title>
<para>
<simpara>
<emphasis>SeasLog</emphasis> 通过系统命令管道调用 `grep -wc` 获取数量,并返回给 PHP (返回数组或单个数值).
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php
@@ -150,9 +150,9 @@ int(1)
<example>
<title>获取某级别下日志的详情</title>
<para>
<simpara>
<emphasis>SeasLog</emphasis> 通过系统命令管道调用 `grep -w` 获取日志详情,并返回数组给 PHP.
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="function.seaslog-get-author" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.seaslog-get-author">
<refnamediv>
<refname>seaslog_get_author</refname>
<refpurpose>获取 SeasLog 作者</refpurpose>
@@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>seaslog_get_author</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
返回一个 SeasLog 作者的字符串
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -55,7 +55,6 @@ string(29) "Chitao.Gao [ neeke@php.net ]"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="function.seaslog-get-version" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.seaslog-get-version">
<refnamediv>
<refname>seaslog_get_version</refname>
<refpurpose>获取 SeasLog 的版本</refpurpose>
@@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>seaslog_get_version</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
返回一个 SeasLog 版本号的字符串
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -55,7 +55,6 @@ string(5) "1.8.4"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ed0559b36f1c31c24c1ec1b641276da111e06f1e Maintainer: neeke Status: ready -->
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: neeke Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<section xmlns="http://docbook.org/ns/docbook" xml:id="seaslog.configuration">
&reftitle.runtime;
@@ -174,17 +174,17 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
日志存储介质的切换选型。1File 2TCP 3UDP (默认为1)
</para>
<para>
</simpara>
<simpara>
<emphasis>seaslog.appender</emphasis> 被切换至 <literal>2 (TCP)</literal><literal>3 (UDP)</literal> 时,
SeasLog 会将日志发送至 tcp://remote_host:remote_port 或者 udp://remote_host:remote_port 服务器。
</para>
<para>
</simpara>
<simpara>
<emphasis>SeasLog</emphasis> 将日志发往 TCP/UDP 时,格式遵守 RFC5424 规范。
此时 <literal>{logInfo}</literal> 受配置项中 <emphasis>seaslog.default_template</emphasis> 的影响。
</para>
</simpara>
<screen>
<![CDATA[
The log style finally formatted such as:
@@ -201,10 +201,10 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
记录日志时的重试次数。
默认为 0 (不重试)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.buffer-disabled-in-cli">
@@ -213,15 +213,15 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
在 CLI 模式下是否关闭 Buffer 的选项。 1-Y 0-N(默认值)
</para>
<para>
</simpara>
<simpara>
在配置中留有 buffer_disabled_in_cli 的开关项。
默认情况下,这个选项是关闭的。
如果将 buffer_disabled_in_cli 设为开启,并且运行在 CLI 时,
配置中的 seaslog.use_buffer 设置将是被忽略的,此时 Seaslog 将立即把日志信息写往存储介质。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.buffer-size">
@@ -230,11 +230,11 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
可以通过该配置项将内存中 Buffer 的条数修改为 100 条。
配置项中 buffer_size 默认值为 0 这意味着将不使用 Buffer。
如果 buffer_size &gt; 0SeasLog 将预先将日志写入内存 Buffer并在 Buffer 的条数大于或等于该值时,写往存储介质,然后刷新内存中的 Buffer。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.default-basepath">
@@ -243,9 +243,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
日志存储的默认根路径。默认值为 "/var/log/www"。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.default-datetime-format">
@@ -254,9 +254,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
时间的格式。默认值为 "Y-m-d H:i:s"。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.default-logger">
@@ -265,9 +265,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
日志记录的默认 Logger。默认值为 "default"。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.disting-by-hour">
@@ -276,14 +276,14 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
是否按每小时一个记录进行区分。1-Y 0-N(默认值)
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.disting_by_hour = 1</emphasis> 时,会将日志区分小时记录。
这意味着SeasLog 将每隔一个小时创建一个文件。
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -293,15 +293,15 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
是否按目录进行区分。1-Y(默认值) 0-N
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.disting_folder = 1</emphasis> 时,按目录区分地使用 Logger。
这意味着SeasLog 将为每一个 Logger 创建一个单独的目录进行区分,比如 default/20180211.log
而当该选项关闭时SeasLog 将使用下划线连接 Logger 与时间,比如 default_20180211.log。
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -311,14 +311,14 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
是否按日志级别进行区分。1-Y 0-N(默认值)
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.disting_type = 1</emphasis> 时,按日志级别使用 Logger。
这意味着SeasLog 将在创建日志文件时,使用 info/warn/error 或其他级别进行区分。
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -328,15 +328,15 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
是否忽略 SeasLog 警告。1-On(默认值) 0-Off
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.ignore_warning = 1</emphasis> 时,忽略 SeasLog 自身的警告,
此时日志目录权限不足、或从远端 Server 端口不能正常响应等导致的警告,将被忽略;
而当关闭该选项时,警告将会出现。
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -346,17 +346,17 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
允许日志被记录的级别。默认为 8 (全部日志)。
0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-ALL
</para>
</simpara>
<note>
<para>
<simpara>
提示: 该配置项从 1.7.0 版本开始有所改变。
在 1.7.0 之前的版本中,越小的值将代表越多的级别日志被记录下来:
0-all 1-debug 2-info 3-notice 4-warning 5-error 6-critical 7-alert 8-emergency
在 1.7.0 之前的版本中,默认值是 0 (全部日志)。
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -366,10 +366,10 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
日志函数所在的层级。这将影响变量 <literal>%F</literal> 中的 <literal>LineNo</literal>
默认值为 0。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.remote-host">
@@ -378,9 +378,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
如果要使用 TCP 或者 UDP 为存储介质,需要配置远端的 IP。默认值为 "127.0.0.1"
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.remote-port">
@@ -389,9 +389,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
如果要使用 TCP 或者 UDP 为存储介质,需要配置远端服务的端口号。默认值为 514
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.remote-timeout">
@@ -400,9 +400,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
如果要使用 TCP 或者 UDP 为存储介质,需要配置超时时间。默认值为 1 秒。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.throw-exception">
@@ -411,15 +411,15 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
是否接受 SeasLog 抛出异常。1-On(默认值) 0-Off
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.throw_exception = 1</emphasis>时,接受 SeasLog 抛出自身的异常,
此时由于日志目录权限问题、或者从远端 Server 端口不能正常响应而导致的中断,
将抛出一个异常;而当关闭该选项时,将不抛出异常。
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -429,9 +429,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
自动将 PHP 的 Final Error 记录在默认 Logger中。1-Y(默认值) 0-N
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trace-exception">
@@ -440,9 +440,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
自动将 PHP 的异常记录在默认 Logger中。1-Y 0-N(默认值)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trace-notice">
@@ -451,9 +451,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
自动将 PHP 的 Notice 记录在默认 Logger中。1-Y 0-N(默认值)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trace-warning">
@@ -462,9 +462,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
自动将 PHP 的 Warning 记录在默认 Logger中。1-Y 0-N(默认值)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trim-wrap">
@@ -473,9 +473,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
自动地 Trim 掉日志信息中的 \n 和 \r。1-On 0-Off(默认值)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.use-buffer">
@@ -484,16 +484,16 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
开启使用内存中的日志 Buffer。1-Y 0-N(默认值)
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.use_buffer = 1</emphasis>时,开启使用内存 Buffer。
默认情况下,内存 Buffer 是关闭的。
如果 Buffer 是开启状态SeasLog 会将日志预先记录在内存中,
并且在请求结束时、或 PHP 进程结束时PHP RSHUTGOWN 或 PHP MSHUTDOWN时写往存储介质。
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -503,22 +503,22 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
默认日志模板。
默认值是 "%T | %L | %P | %Q | %t | %M".
</para>
</simpara>
<note>
<para>
<simpara>
提供了一系列的默认变量,可以在日志模板中使用,并在最终日志生成时,这些变量的占位符会被替换成对应的值。
</para>
<para>
</simpara>
<simpara>
默认的日志模板是:<literal>seaslog.default_template = "%T | %L | %P | %Q | %t | %M"</literal>
这意味着,默认的日志格式会是:<literal>{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}</literal>
</para>
<para>
</simpara>
<simpara>
如果修改了日志模板,比如:<literal>seaslog.default_template = "[%T]:%L %P %Q %t %M"</literal>
这意味着,日志的格式将会成改变为:<literal>[{dateTime}]:{level} {pid} {uniqid} {timeStamp} {logInfo}</literal>
</para>
</simpara>
<table>
<title>Seaslog 内置变量表</title>
<tgroup cols="2">

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.alert" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.alert">
<refnamediv>
<refname>SeasLog::alert</refname>
<refpurpose>记录 alert 日志</refpurpose>
@@ -18,10 +18,10 @@
<para>
记录 alert 日志
<note>
<para>
<simpara>
“ALERT”——必须立即采取行动的紧急事件
需要立即通知相关人员紧急修复。
</para>
</simpara>
</note>
</para>
@@ -33,28 +33,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志的消息
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +62,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -133,7 +133,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.critical" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.critical">
<refnamediv>
<refname>SeasLog::critical</refname>
<refpurpose>记录 critical 日志</refpurpose>
@@ -18,12 +18,12 @@
<para>
记录 critical 日志
<note>
<para>
<simpara>
“CRITICAL”——紧急情况、需要立刻进行修复、程序组件不可用
</para>
</simpara>
</note>
</para>
</refsect1>
<refsect1 role="parameters">
@@ -32,28 +32,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志的消息
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -131,7 +131,6 @@ array(2) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.debug" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.debug">
<refnamediv>
<refname>SeasLog::debug</refname>
<refpurpose>记录 debug 日志</refpurpose>
@@ -18,9 +18,9 @@
<para>
记录debug日志
<note>
<para>
<simpara>
“DEBUG”——debug 信息、细粒度信息事件
</para>
</simpara>
</note>
</para>
@@ -32,28 +32,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志的消息
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -132,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.emergency" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.emergency">
<refnamediv>
<refname>SeasLog::emergency</refname>
<refpurpose>记录 emergency 日志</refpurpose>
@@ -18,9 +18,9 @@
<para>
记录 emergency 日志
<note>
<para>
<simpara>
“EMERGENCY”——系统不可用。
</para>
</simpara>
</note>
</para>
@@ -32,28 +32,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志的消息
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -132,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.error">
<refnamediv>
<refname>SeasLog::error</refname>
<refpurpose>记录 error 日志</refpurpose>
@@ -18,9 +18,9 @@
<para>
记录 error 日志
<note>
<para>
<simpara>
“ERROR”——运行时出现的错误、不必要立即进行修复、不影响整个逻辑的运行、需要记录并做检测
</para>
</simpara>
</note>
</para>
@@ -32,28 +32,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志的消息
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -132,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.flushbuffer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.flushbuffer">
<refnamediv>
<refname>SeasLog::flushBuffer</refname>
<refpurpose>将日志缓存刷新到介质中,文件介质,或者发送到远端的 TCP/UDP 服务地址</refpurpose>
@@ -11,18 +11,18 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::flushBuffer</methodname>
<void />
<void/>
</methodsynopsis>
<para>
将日志缓存按照 <link linkend="ini.seaslog.appender">seaslog.appender</link> 刷新到介质:
文件介质,或发送到远端的 TCP/UDP 服务地址。
<note>
<para>
<simpara>
同时请留意:
<link linkend="ini.seaslog.appender-retry">seaslog.appender_retry</link>
<link linkend="ini.seaslog.remote-host">seaslog.remote_host</link>
<link linkend="ini.seaslog.remote-port">seaslog.remote_port</link>
</para>
</simpara>
</note>
</para>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
刷新成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -92,7 +92,6 @@ array(0) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.getbasepath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getbasepath">
<refnamediv>
<refname>SeasLog::getBasePath</refname>
<refpurpose>获得 SeasLog 根目录</refpurpose>
@@ -11,15 +11,15 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>Seaslog::getBasePath</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
使用函数 <methodname>SeasLog::getBasePath</methodname>
可以获得在 php.ini(seaslog.ini) 中设置的<link linkend="ini.seaslog.default-basepath">seaslog.default_basepath</link>
</para>
<para>
</simpara>
<simpara>
如果使用函数 <methodname>Seaslog::setBasePath</methodname>,将改变函数取值。
</para>
</simpara>
</refsect1>
@@ -30,9 +30,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<link linkend="ini.seaslog.default-basepath">seaslog.default_basepath</link> 作为字符串返回。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -59,7 +59,6 @@ string(12) "/var/log/www"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.getbuffer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getbuffer">
<refnamediv>
<refname>SeasLog::getBuffer</refname>
<refpurpose>获取内存中的日志缓存数组</refpurpose>
@@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>SeasLog::getBuffer</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
以 Array 形式返回内存中的日志缓存。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -80,7 +80,6 @@ array(1) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.getdatetimeformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getdatetimeformat">
<refnamediv>
<refname>SeasLog::getDatetimeFormat</refname>
<refpurpose>获取 SeasLog 日期格式</refpurpose>
@@ -11,14 +11,14 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>SeasLog::getDatetimeFormat</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
获取 SeasLog 日期格式。
使用函数 <methodname>SeasLog::getDatetimeFormat</methodname> 将获取 php.ini(seaslog.ini)
配置的 <link linkend="ini.seaslog.default-datetime-format">seaslog.default_datetime_format</link>
使用函数 <methodname>SeasLog::getDatetimeFormat</methodname> 将获取 php.ini(seaslog.ini)
配置的 <link linkend="ini.seaslog.default-datetime-format">seaslog.default_datetime_format</link>
值。
</para>
</simpara>
</refsect1>
@@ -29,10 +29,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
获取 SeasLog 配置中的 <link linkend="ini.seaslog.default-datetime-format">seaslog.default_datetime_format</link> 值。
使用函数 <methodname>SeasLog::setDatetimeFormat</methodname> 将改变本函数的取值。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -70,7 +70,6 @@ string(7) "Ymd His"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.getlastlogger" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getlastlogger">
<refnamediv>
<refname>SeasLog::getLastLogger</refname>
<refpurpose>获得 SeasLog 最近的一次 Logger 名称</refpurpose>
@@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>SeasLog::getLastLogger</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
使用函数 <methodname>SeasLog::getLastLogger</methodname> 将获取 php.ini(seaslog.ini) 中配置的 <link linkend="ini.seaslog.default-logger">seaslog.default_logger</link> 值。
</para>
</simpara>
</refsect1>
@@ -26,10 +26,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
使用函数 <methodname>SeasLog::setLogger</methodname>
<simpara>
使用函数 <methodname>SeasLog::setLogger</methodname>
将改变函数 <methodname>SeasLog::getLastLogger</methodname> 的取值。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -65,7 +65,6 @@ string(12) "theNewLogger"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 73fae4ee51b644b72028e610abefefced57c18ad Maintainer: neeke Status: ready -->
<refentry xml:id="seaslog.getrequestid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: neeke Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getrequestid">
<refnamediv>
<refname>SeasLog::getRequestID</refname>
<refpurpose>获得当前 SeasLog 中用于区分请求的 request_id</refpurpose>
@@ -11,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>SeasLog::getRequestID</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
为了区分一个独立的请求,如果没有调用函数 <methodname>SeasLog::setRequestId</methodname>
进行指定SeasLog 将会在请求初始化时,使用内置函数 `static char *get_uniqid ()` 生成一个 unique 值。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,10 +26,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
返回一个由内置函数 `static char *get_uniqid ()` 生成或由用户调用函数
<methodname>SeasLog::setRequestId</methodname> 指定的字符串。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -62,13 +62,12 @@ string(26) "reqeust_id_test_1530864034"
&reftitle.seealso;
<simplelist>
<member><methodname>SeasLog::setRequestID</methodname></member>
<member>在 Seaslog 默认变量表中的 `%Q` <link linkend="ini.seaslog.default-template"></link></member>
<member>在 Seaslog 默认变量表中的 `%Q` <link linkend="ini.seaslog.default-template"/></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.info">
<refnamediv>
<refname>SeasLog::info</refname>
<refpurpose>Record info log information</refpurpose>
@@ -18,9 +18,9 @@
<para>
记录 info 日志
<note>
<para>
<simpara>
“INFO”——重要事件、强调应用程序的运行过程。
</para>
</simpara>
</note>
</para>
@@ -32,28 +32,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志消息。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -132,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.log" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.log">
<refnamediv>
<refname>SeasLog::log</refname>
<refpurpose>公共的日志记录函数</refpurpose>
@@ -16,9 +16,9 @@
<methodparam choice="opt"><type>array</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>logger</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
公共的日志记录函数。可用于调用者扩展日志模板或级别。
</para>
</simpara>
</refsect1>
@@ -47,28 +47,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志消息
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -76,9 +76,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -172,7 +172,6 @@ array(1) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.notice" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.notice">
<refnamediv>
<refname>SeasLog::notice</refname>
<refpurpose>记录 notice 日志</refpurpose>
@@ -18,9 +18,9 @@
<para>
记录 notice 日志。
<note>
<para>
<simpara>
“NOTICE”——一般重要性事件、执行过程中较 INFO 级别更为重要的信息。
</para>
</simpara>
</note>
</para>
@@ -32,28 +32,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志的消息
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -133,7 +133,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.setbasepath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setbasepath">
<refnamediv>
<refname>SeasLog::setBasePath</refname>
<refpurpose>设置 SeasLog 根目录</refpurpose>
@@ -13,9 +13,9 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setBasePath</methodname>
<methodparam><type>string</type><parameter>base_path</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
设置 SeasLog 根目录。
</para>
</simpara>
</refsect1>
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>base_path</parameter></term>
<listitem>
<para>
<simpara>
String.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
设置根目录成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -64,7 +64,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.setdatetimeformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setdatetimeformat">
<refnamediv>
<refname>SeasLog::setDatetimeFormat</refname>
<refpurpose>设置 SeasLog 日期格式</refpurpose>
@@ -13,9 +13,9 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setDatetimeFormat</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
设置 SeasLog 日期格式。
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +27,9 @@
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<simpara>
字符串。比如 `Y-m-d H:i:s` 或者 `Ymd His`。查看函数 <function>date</function> 的第一个参数 `format`。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
设置日期时间格式成功时返回 TRUE失败时返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -73,7 +73,6 @@ bool(true)
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.setlogger" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setlogger">
<refnamediv>
<refname>SeasLog::setLogger</refname>
<refpurpose>设置 SeasLog 的 Logger 名</refpurpose>
@@ -13,11 +13,11 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setLogger</methodname>
<methodparam><type>string</type><parameter>logger</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
使用函数 <methodname>SeasLog::setLogger</methodname>
将改变函数 <methodname>SeasLog::getLastLogger</methodname> 的取值。
这意味着SeasLog 将会把日志信息记录在该 Logger 下。
</para>
</simpara>
</refsect1>
@@ -27,9 +27,9 @@
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
Logger name.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
设置 Logger 成功(在存储介质为文件时将创建目录或文件)返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -73,7 +73,6 @@ bool(true)
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.setrequestid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setrequestid">
<refnamediv>
<refname>SeasLog::setRequestID</refname>
<refpurpose>设置可以由 SeasLog 用于区分请求的 request_id</refpurpose>
@@ -13,10 +13,10 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setRequestID</methodname>
<methodparam><type>string</type><parameter>request_id</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
为了区分一个独立的请求,如果没有调用函数 <methodname>SeasLog::setRequestId</methodname>
进行指定,将会在请求初始化时,使用内置函数 `static char *get_uniqid ()` 生成一个 unique 值。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>request_id</parameter></term>
<listitem>
<para>
<simpara>
String.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
设置 request_id 成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -71,7 +71,6 @@ bool(true)
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4691215483797da841e61de00eef8adba2960d21 Maintainer: Panda Status: ready -->
<refentry xml:id="seaslog.warning" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: 60f4ad4299fdef80add3746dcbd848abe0226157 Maintainer: Panda Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.warning">
<refnamediv>
<refname>SeasLog::warning</refname>
<refpurpose>Record warning log information</refpurpose>
@@ -18,9 +18,9 @@
<para>
记录 warning 日志信息。
<note>
<para>
<simpara>
“WARNING”——出现了非错误性的异常信息、潜在异常信息、需要关注并且需要修复。
</para>
</simpara>
</note>
</para>
@@ -32,28 +32,28 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
日志信息。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
`message` 包含占位符,实现用 content 数组中的值替换这些占位符。
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' => neeke)`
例如 `message` 是 `log info from {NAME}``content` 是 `array('NAME' =&gt; neeke)`
日志信息是 `log info from neeke`。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
当函数调用 SeasLog::setLogger() 时,就像临时 logger 一样,在第三个参数中使用这个 `logger`。
如果 `logger` 为 NULL 或 "",那么 SeasLog 将使用由 <methodname>SeasLog::setLogger</methodname> 设置的最新日志记录程序。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
记录日志信息成功返回 TRUE失败返回 FALSE。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -132,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml