Mercurial > hg > nginx-site

comparison xml/en/docs/ngx_google_perftools_module.xml @ 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
children 16bad57a412a
comparison
equal deleted inserted replaced
1850:8eae6bc1ea22 1851:9463f1412255
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd">
8
9 <module name="Module ngx_google_perftools_module"
10 link="/en/docs/ngx_google_perftools_module.html"
11 lang="en"
12 rev="1">
13
14 <section id="summary">
15
16 <para>
17 The <literal>ngx_google_perftoos_module</literal> module (0.6.29) enables
18 profiling of nginx worker processes using
19 <link url="https://github.com/gperftools/gperftools">Google Performance Tools</link>.
20 The module is intended for nginx developers.
21 </para>
22
23 <para>
24 This module is not built by default, it should be enabled with the
25 <literal>--with-google_perftools_module</literal>
26 configuration parameter.
27 <note>
28 This module requires the
29 <link url="https://github.com/gperftools/gperftools">gperftools</link> library.
30 </note>
31 </para>
32
33 </section>
34
35
36 <section id="example" name="Example Configuration">
37
38 <para>
39 <example>
40 google_perftools_profiles /path/to/profile;
41 </example>
42 Profiles will be stored as
43 <literal>/path/to/profile.&lt;worker_pid&gt;</literal>.
44 </para>
45
46 </section>
47
48
49 <section id="directives" name="Directives">
50
51 <directive name="google_perftools_profiles">
52 <syntax><value>file</value></syntax>
53 <default/>
54 <context>main</context>
55
56 <para>
57 Sets a file name that keeps profiling information of
58 nginx worker process.
59 The ID of the worker process is always a part of the file name
60 and is appended to the end of the file name, after a dot.
61 </para>
62
63 </directive>
64
65 </section>
66
67 </module>