Mercurial > hg > nginx-site
diff xml/en/docs/ngx_google_perftools_module.xml @ 1851:9463f1412255
Documented ngx_google_perftools_module.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Mon, 05 Dec 2016 21:01:46 +0300 |
parents | |
children | 16bad57a412a |
line wrap: on
line diff
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.<worker_pid></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>