summaryrefslogtreecommitdiff
path: root/pod/nginx/ngx_google_perftools_module.pod
blob: 2bdf7a59423ff8675e03ba49a229995aa3a0a69d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
=encoding utf-8

=head1 NAME

ngx_google_perftools_module - Module ngx_google_perftools_module




=head1



The C<ngx_google_perftools_module> module (0.6.29) enables
profiling of nginx worker processes using
L<Google Performance Tools|https://github.com/gperftools/gperftools>.
The module is intended for nginx developers.





This module is not built by default, it should be enabled with the
C<--with-google_perftools_module>
configuration parameter.

B<NOTE>

This module requires the
L<gperftools|https://github.com/gperftools/gperftools> library.





=head1 Example Configuration




    
    google_perftools_profiles /path/to/profile;


Profiles will be stored as
C<E<sol>pathE<sol>toE<sol>profile.E<lt>worker_pidE<gt>>.




=head1 Directives

=head2 google_perftools_profiles


B<syntax:> google_perftools_profiles I<I<C<file>>>



B<context:> I<main>





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.