[phpdoc-zh] r226 committed - [PHPDOC-ZH] [翻译] reference.xhprof 一节

1 view

Skip to first unread message

phpd...@googlecode.com

unread,

May 15, 2012, 4:20:22 AM5/15/12

to phpd...@googlegroups.com

Revision: 226
Author: ice.shiny
Date: Tue May 15 01:20:02 2012
Log: [PHPDOC-ZH] [翻译] reference.xhprof 一节
http://code.google.com/p/phpdoc-zh/source/detail?r=226

Added:
/trunk/xml/reference/xhprof
/trunk/xml/reference/xhprof/book.xml
/trunk/xml/reference/xhprof/constants.xml
/trunk/xml/reference/xhprof/examples.xml
/trunk/xml/reference/xhprof/functions
/trunk/xml/reference/xhprof/functions/xhprof-disable.xml
/trunk/xml/reference/xhprof/functions/xhprof-enable.xml
/trunk/xml/reference/xhprof/functions/xhprof-sample-disable.xml
/trunk/xml/reference/xhprof/functions/xhprof-sample-enable.xml
/trunk/xml/reference/xhprof/ini.xml
/trunk/xml/reference/xhprof/setup.xml

=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/book.xml Tue May 15 01:20:02 2012
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<book xml:id="book.xhprof" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title>多层性能分析器</title>
+ <titleabbrev>Xhprof</titleabbrev>
+
+ <preface xml:id="intro.xhprof">
+ &reftitle.intro;
+ <para>
+ XHProf是一个轻量的基于性能测量的多层分析器。在数据收集阶段，它跟踪调用次
数与测量数据以弧线展示程序的动态调用图。
+ 它在报告/后处理阶段计算了独占的性能度量，例如运行经过的时间、CPU计算时间
和内存开销。函数性能报告可以被调用者或者被调用者终止。
+ 在数据搜集阶段XHProf通过调用图检查循环来处理递归函数，通过赋予唯一名称来
避免递归调用的循环。
+ </para>
+ <para>
+ XHProf包涵了一个基于HTML的简单用户界面(由PHP写成)。基于浏览器的用户界面
使得浏览或者分享性能数据结果更简便。同时支持查看调用图。
+ </para>
+ <para>
+ XHProf的报告常常对理解代码执行结构很有帮助。比如此分层报告可用于确定某个
函数在何种调用链里被调用。
+ </para>
+ <para>
+ XHProf支持对比两次运行 (又名 "diff" 报告)，或者多次运行数据的合计。对比
合并报告，很像针对单次运行的“平式视图”性能报告，就像“分层式视图”的性能报告。
+ </para>
+ <para>
+ 更多额外文档可以在
+ <link xlink:href="&url.xhprof.docs.facebook;">facebook xhprof</link> 上
找到。
+ </para>
+ </preface>
+
+ &reference.xhprof.setup;
+ &reference.xhprof.constants;
+ &reference.xhprof.examples;
+ &reference.xhprof.reference;
+
+</book>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/constants.xml Tue May 15 01:20:02 2012
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<appendix xml:id="xhprof.constants" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ &reftitle.constants;
+ &extension.constants;
+ <variablelist>
+ <varlistentry xml:id="constant.xhprof-flags-no-builtins">
+ <term>
+ <constant>XHPROF_FLAGS_NO_BUILTINS</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ 用于跳过所有内建的(内部)函数。
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.xhprof-flags-cpu">
+ <term>
+ <constant>XHPROF_FLAGS_CPU</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ 用于在输出的性能数据中添加 <acronym>CPU</acronym> 数据。
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.xhprof-flags-memory">
+ <term>
+ <constant>XHPROF_FLAGS_MEMORY</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ 用于输出的性能数据中添加内存数据。
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</appendix>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/examples.xml Tue May 15 01:20:02 2012
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<chapter xml:id="xhprof.examples" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ &reftitle.examples;
+ <example>
+ <title>使用可选图形界面的Xhprof示例</title>
+ <para>
+ 本示例启动并结束性能分析器，然后使用捆绑的用户界面来保存和解析结果。换
言之，扩展的代码在调用 <function>xhprof_disable</function> 函数后结束。
+ </para>
+ <programlisting role="php">
+<![CDATA[
+<?php
+xhprof_enable(XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY);
+
+for ($i = 0; $i <= 1000; $i++) {
+ $a = $i * $i;
+}
+
+$xhprof_data = xhprof_disable();
+
+$XHPROF_ROOT = "/tools/xhprof/";
+include_once $XHPROF_ROOT . "/xhprof_lib/utils/xhprof_lib.php";
+include_once $XHPROF_ROOT . "/xhprof_lib/utils/xhprof_runs.php";
+
+$xhprof_runs = new XHProfRuns_Default();
+$run_id = $xhprof_runs->save_run($xhprof_data, "xhprof_testing");
+
+echo "http://localhost/xhprof/xhprof_html/index.php?run={$run_id}&source=xhprof_testing\n";
+
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+http://localhost/xhprof/xhprof_html/index.php?run=t11_4bdf44d21121f&source=xhprof_testing
+]]>
+ </screen>
+ </example>
+</chapter>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/functions/xhprof-disable.xml Tue May 15
01:20:02 2012
@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<refentry xml:id="function.xhprof-disable"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>xhprof_disable</refname>
+ <refpurpose>停止xhprof分析器</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>xhprof_disable</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ 停止性能分析，并返回此次运行的xhprof数据。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ 本次运行的xhprof <type>array</type> 数据。
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><function>xhprof_disable</function> 示例</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+xhprof_enable();
+
+$foo = strlen("foo bar");
+
+$xhprof_data = xhprof_disable();
+
+print_r($xhprof_data);
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+Array
+(
+ [main()==>strlen] => Array
+ (
+ [ct] => 1
+ [wt] => 279
+ )
+
+ [main()==>xhprof_disable] => Array
+ (
+ [ct] => 1
+ [wt] => 9
+ )
+
+ [main()] => Array
+ (
+ [ct] => 1
+ [wt] => 610
+ )
+
+)
+]]>
+ </screen>
+ </example>
+ </refsect1>
+
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/functions/xhprof-enable.xml Tue May 15
01:20:02 2012
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<refentry xml:id="function.xhprof-enable"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>xhprof_enable</refname>
+ <refpurpose>启动xhprof性能分析器</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>xhprof_enable</methodname>
+ <methodparam
choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
+ <methodparam
choice="opt"><type>array</type><parameter>options</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ 启动xhprof进行性能分析。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>flags</parameter></term>
+ <listitem>
+ <para>
+ 为分析额外信息的可选标志。关于此标记的更多信息参见
+ <link linkend="xhprof.constants">XHprof constants</link> ，例如，
<constant>XHPROF_FLAGS_MEMORY</constant>
+ 开启内存的分析。
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 一个 <type>array</type> 的可选选项，亦即通过传
递 'ignored_functions' 选项，忽略性能分析中的某些函数。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &null;
+ </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>0.9.2</entry>
+ <entry>
+ 添加可选的 <parameter>options</parameter> 参数。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><function>xhprof_enable</function> 示例</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+// 1. elapsed time + memory + CPU profiling; and ignore built-in
(internal) functions
+xhprof_enable(XHPROF_FLAGS_NO_BUILTINS | XHPROF_FLAGS_CPU |
XHPROF_FLAGS_MEMORY);
+
+// 2. elapsed time profiling; ignore call_user_func* during profiling
+xhprof_enable(
+ 0,
+ array('ignored_functions' => array('call_user_func',
+ 'call_user_func_array')));
+
+// 3. elapsed time + memory profiling; ignore call_user_func* during
profiling
+xhprof_enable(
+ XHPROF_FLAGS_MEMORY,
+ array('ignored_functions' => array('call_user_func',
+ 'call_user_func_array')));
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>xhprof_disable</function></member>
+ <member><function>xhprof_sample_enable</function></member>
+ <member><function>memory_get_usage</function></member>
+ <member><function>getrusage</function></member>
+ </simplelist>
+ </refsect1>
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/functions/xhprof-sample-disable.xml Tue May
15 01:20:02 2012
@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<refentry xml:id="function.xhprof-sample-disable"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>xhprof_sample_disable</refname>
+ <refpurpose>停止xhprof性能采样分析器</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>xhprof_sample_disable</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ 停止采样模式的xhprof分析器
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ 本次运行 <type>array</type> 类型的xhprof采样数据
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><function>xhprof_sample_disable</function> 示例</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+xhprof_sample_enable();
+
+for ($i = 0; $i <= 10000; $i++) {
+ $a = strlen($i);
+ $b = $i * $a;
+ $c = rand();
+}
+
+$xhprof_data = xhprof_sample_disable();
+
+print_r($xhprof_data);
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+Array
+(
+ [1272935300.800000] => main()
+ [1272935300.900000] => main()
+)
+]]>
+ </screen>
+ </example>
+ </refsect1>
+
+
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/functions/xhprof-sample-enable.xml Tue May
15 01:20:02 2012
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<refentry xml:id="function.xhprof-sample-enable"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>xhprof_sample_enable</refname>
+ <refpurpose>开始xhprof性能采样模式分析</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>xhprof_sample_enable</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ <function>xhprof_enable</function> 更轻量的版本，以采样模式开始性能分
析。抽样的间隔为0.1秒，样本记录了完整的函数调用堆栈。主要使用的情况是以较低
的性能开销来进行性能监控和诊断。
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &null;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>xhprof_sample_disable</function></member>
+ <member><function>xhprof_enable</function></member>
+ <member><function>memory_get_usage</function></member>
+ <member><function>getrusage</function></member>
+ </simplelist>
+ </refsect1>
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/ini.xml Tue May 15 01:20:02 2012
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<section xml:id="xhprof.configuration"
xmlns="http://docbook.org/ns/docbook">
+ &reftitle.runtime;
+ &extension.runtime;
+ <para>
+ <table>
+ <title>Xhprof &ConfigureOptions;</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>&Name;</entry>
+ <entry>&Default;</entry>
+ <entry>&Changeable;</entry>
+ <entry>&Changelog;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><link
linkend="ini.xhprof.output-dir">xhprof.output_dir</link></entry>
+ <entry>""</entry>
+ <entry><constant>PHP_INI_ALL</constant></entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+
+ &ini.descriptions.title;
+
+ <variablelist>
+ <varlistentry xml:id="ini.xhprof.output-dir">
+ <term>
+ <parameter>xhprof.output_dir</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ 储存XHProf运行数据的默认目录，用于接口iXHProfRuns(即
XHProfRuns_Default类)。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</section>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/xhprof/setup.xml Tue May 15 01:20:02 2012
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+
+<chapter xml:id="xhprof.setup" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ &reftitle.setup;
+
+ <section xml:id="xhprof.requirements">
+ &reftitle.required;
+ <para>
+ 虽然不是必需的，xhprof包含了一个用PHP写成的界面。它是一个保存分析后的数
据、并用浏览器显示的实用办法。因此开启了PHP的web服务器将使xhprof更加有用。
+ </para>
+ <para>
+ 在 <link
xlink:href="&url.xhprof.gui.fork1;">&url.xhprof.gui.fork1;</link> 也有一个
GUI界面的分支。
+ </para>
+ </section>
+
+ &reference.xhprof.configure;
+ &reference.xhprof.ini;
+
+ <section xml:id="xhprof.resources">
+ &reftitle.resources;
+ &no.resource;
+ </section>
+
+</chapter>
+
+

Reply all

Reply to author

Forward

0 new messages