Mercurial > hg > nginx-site

changeset 1851:9463f1412255

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented ngx_google_perftools_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 05 Dec 2016 21:01:46 +0300
parents 8eae6bc1ea22
children 68a4e583a7e4
files xml/en/GNUmakefile xml/en/docs/index.xml xml/en/docs/ngx_google_perftools_module.xml xml/ru/GNUmakefile xml/ru/docs/index.xml xml/ru/docs/ngx_google_perftools_module.xml
diffstat 6 files changed, 160 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/GNUmakefile
+++ b/xml/en/GNUmakefile
@@ -113,6 +113,7 @@ REFS =									\
 		stream/ngx_stream_ssl_preread_module			\
 		stream/ngx_stream_upstream_module			\
 		stream/stream_processing				\
+		ngx_google_perftools_module				\
 
 TOP =									\
 		download						\
--- a/xml/en/docs/index.xml
+++ b/xml/en/docs/index.xml
@@ -8,7 +8,7 @@
 <article name="nginx documentation"
          link="/en/docs/"
          lang="en"
-         rev="36"
+         rev="37"
          toc="no">
 
 
@@ -585,6 +585,17 @@ ngx_stream_upstream_module</link>
 </list>
 </para>
 
+<para>
+<list type="bullet">
+
+<listitem>
+<link doc="ngx_google_perftools_module.xml">
+ngx_google_perftools_module</link>
+</listitem>
+
+</list>
+</para>
+
 </section>
 
 </article>
new file mode 100644
--- /dev/null
+++ b/xml/en/docs/ngx_google_perftools_module.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../dtd/module.dtd">
+
+<module name="Module ngx_google_perftools_module"
+        link="/en/docs/ngx_google_perftools_module.html"
+        lang="en"
+        rev="1">
+
+<section id="summary">
+
+<para>
+The <literal>ngx_google_perftoos_module</literal> module (0.6.29) enables
+profiling of nginx worker processes using
+<link url="https://github.com/gperftools/gperftools">Google Performance Tools</link>.
+The module is intended for nginx developers.
+</para>
+
+<para>
+This module is not built by default, it should be enabled with the
+<literal>--with-google_perftools_module</literal>
+configuration parameter.
+<note>
+This module requires the
+<link url="https://github.com/gperftools/gperftools">gperftools</link> library.
+</note>
+</para>
+
+</section>
+
+
+<section id="example" name="Example Configuration">
+
+<para>
+<example>
+google_perftools_profiles /path/to/profile;
+</example>
+Profiles will be stored as
+<literal>/path/to/profile.&lt;worker_pid&gt;</literal>.
+</para>
+
+</section>
+
+
+<section id="directives" name="Directives">
+
+<directive name="google_perftools_profiles">
+<syntax><value>file</value></syntax>
+<default/>
+<context>main</context>
+
+<para>
+Sets a file name that keeps profiling information of
+nginx worker process.
+The ID of the worker process is always a part of the file name
+and is appended to the end of the file name, after a dot.
+</para>
+
+</directive>
+
+</section>
+
+</module>
--- a/xml/ru/GNUmakefile
+++ b/xml/ru/GNUmakefile
@@ -102,6 +102,7 @@ REFS =									\
 		stream/ngx_stream_ssl_preread_module			\
 		stream/ngx_stream_upstream_module			\
 		stream/stream_processing				\
+		ngx_google_perftools_module				\
 
 TOP =									\
 		download						\
--- a/xml/ru/docs/index.xml
+++ b/xml/ru/docs/index.xml
@@ -8,7 +8,7 @@
 <article name="nginx: документация"
          link="/ru/docs/"
          lang="ru"
-         rev="36"
+         rev="37"
          toc="no">
 
 
@@ -589,6 +589,17 @@ ngx_stream_upstream_module</link>
 </list>
 </para>
 
+<para>
+<list type="bullet">
+
+<listitem>
+<link doc="ngx_google_perftools_module.xml">
+ngx_google_perftools_module</link>
+</listitem>
+
+</list>
+</para>
+
 </section>
 
 </article>
new file mode 100644
--- /dev/null
+++ b/xml/ru/docs/ngx_google_perftools_module.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../dtd/module.dtd">
+
+<module name="Модуль ngx_google_perftools_module"
+        link="/ru/docs/ngx_google_perftools_module.html"
+        lang="ru"
+        rev="1">
+
+<section id="summary">
+
+<para>
+Модуль <literal>ngx_google_perftoos_module</literal> (0.6.29) включает
+поддержку профилирования рабочих процессов nginx при помощи
+<link url="https://github.com/gperftools/gperftools">Google Performance Tools</link>.
+Модуль предназначен для разработчиков nginx.
+</para>
+
+<para>
+По умолчанию этот модуль не собирается, его сборку необходимо
+разрешить с помощью конфигурационного параметра
+<literal>--with-google_perftools_module</literal>.
+<note>
+Для сборки и работы этого модуля нужна библиотека
+<link url="https://github.com/gperftools/gperftools">gperftools</link>.
+</note>
+</para>
+
+</section>
+
+
+<section id="example" name="Пример конфигурации">
+
+<para>
+<example>
+google_perftools_profiles /path/to/profile;
+</example>
+Профили будут сохраняться как
+<literal>/path/to/profile.&lt;worker_pid&gt;</literal>.
+</para>
+
+</section>
+
+
+<section id="directives" name="Директивы">
+
+<directive name="google_perftools_profiles">
+<syntax><value>файл</value></syntax>
+<default/>
+<context>main</context>
+
+<para>
+Задаёт имя файла, который хранит информацию о профилировании
+рабочего процесса nginx.
+Идентификатор рабочего процесса всегда является частью имени файла
+и прибавляется в конце имени после точки.
+</para>
+
+</directive>
+
+</section>
+
+</module>