Mercurial > hg > nginx-site
annotate xml/en/docs/ngx_google_perftools_module.xml @ 2636:a0824dab33ff
nginx-1.19.6
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Tue, 15 Dec 2020 17:57:20 +0300 |
parents | 16bad57a412a |
children |
rev | line source |
---|---|
1851
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
2 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
3 <!-- |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) Nginx, Inc. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
5 --> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
6 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
7 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd"> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
8 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
9 <module name="Module ngx_google_perftools_module" |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
10 link="/en/docs/ngx_google_perftools_module.html" |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
11 lang="en" |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
12 rev="1"> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
13 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
14 <section id="summary"> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
15 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
16 <para> |
2371
16bad57a412a
Fixed typos (ticket #1769).
Sergey Kandaurov <pluknet@nginx.com>
parents:
1851
diff
changeset
|
17 The <literal>ngx_google_perftools_module</literal> module (0.6.29) enables |
1851
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
18 profiling of nginx worker processes using |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
19 <link url="https://github.com/gperftools/gperftools">Google Performance Tools</link>. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
20 The module is intended for nginx developers. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
21 </para> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
22 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
23 <para> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
24 This module is not built by default, it should be enabled with the |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
25 <literal>--with-google_perftools_module</literal> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
26 configuration parameter. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
27 <note> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
28 This module requires the |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
29 <link url="https://github.com/gperftools/gperftools">gperftools</link> library. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
30 </note> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
31 </para> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
32 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
33 </section> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
34 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
35 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
36 <section id="example" name="Example Configuration"> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
37 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
38 <para> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
39 <example> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
40 google_perftools_profiles /path/to/profile; |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
41 </example> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
42 Profiles will be stored as |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
43 <literal>/path/to/profile.<worker_pid></literal>. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
44 </para> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
45 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
46 </section> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
47 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
48 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
49 <section id="directives" name="Directives"> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
50 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
51 <directive name="google_perftools_profiles"> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
52 <syntax><value>file</value></syntax> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
53 <default/> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
54 <context>main</context> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
55 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
56 <para> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
57 Sets a file name that keeps profiling information of |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
58 nginx worker process. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
59 The ID of the worker process is always a part of the file name |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
60 and is appended to the end of the file name, after a dot. |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
61 </para> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
62 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
63 </directive> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
64 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
65 </section> |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
66 |
9463f1412255
Documented ngx_google_perftools_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
67 </module> |