Skip to content
This repository has been archived by the owner on Dec 3, 2019. It is now read-only.

refactor the main probe loop #108

Merged
merged 9 commits into from
Aug 3, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/man.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,18 +79,17 @@ is not specified.

The following options are less commonly used.

**-T**, **--timestamp**
: Print the timestamp for each stack. This is useful for generating "flame
chart" profiles. Generally regular flame graphs are encouraged, since the
timestamp flame charts are harder to use.

**--abi**=*VERSION*
: Force a particular Python ABI. This option should only be needed in edge
cases when profiling embedded Python builds (e.g. uWSGI), and only if
pyflame doesn't automatically detect the correct ABI. *VERSION* should be a
two digit integer consisting of the Python major and minor version, e.g. 27
for Python 2.7 or 36 for Python 3.6.

**--flamechart**
: Print the timestamp for each stack. This is useful for generating "flame
chart" profiles. Generally regular flame graphs are encouraged, since the
timestamp flame charts are harder to use.

# ONLINE DOCUMENTATION

Expand Down
18 changes: 9 additions & 9 deletions docs/pyflame.man
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 1.19.1
.\"
.TH "PYFLAME" "1" "July 2017" "" ""
.TH "PYFLAME" "1" "August 2017" "" ""
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -106,14 +106,6 @@ Enable profiling multi\-threaded Python apps.
.PP
The following options are less commonly used.
.TP
.B \f[B]\-T\f[], \f[B]\-\-timestamp\f[]
Print the timestamp for each stack.
This is useful for generating "flame chart" profiles.
Generally regular flame graphs are encouraged, since the timestamp flame
charts are harder to use.
.RS
.RE
.TP
.B \f[B]\-\-abi\f[]=\f[I]VERSION\f[]
Force a particular Python ABI.
This option should only be needed in edge cases when profiling embedded
Expand All @@ -125,6 +117,14 @@ major and minor version, e.g.
27 for Python 2.7 or 36 for Python 3.6.
.RS
.RE
.TP
.B \f[B]\-\-flamechart\f[]
Print the timestamp for each stack.
This is useful for generating "flame chart" profiles.
Generally regular flame graphs are encouraged, since the timestamp flame
charts are harder to use.
.RS
.RE
.SH ONLINE DOCUMENTATION
.PP
You can find the complete documentation online at:
Expand Down
8 changes: 4 additions & 4 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,14 @@ stamp output format, useful for generating `"flame charts"
inverted flame graph) that are viewable in Chrome. In some cases, the flame
chart format is easier to understand.

To generate a flame chart, use ``pyflame -T``, and then pass the output to
``utils/flame-chart-json`` to convert the output into the JSON format required
by the Chrome CPU profiler:
To generate a flame chart, use ``pyflame --flamechart``, and then pass the
output to ``utils/flame-chart-json`` to convert the output into the JSON format
required by the Chrome CPU profiler:

.. code:: bash

# Generate flame chart data viewable in Chrome.
pyflame -T [other pyflame options] | flame-chart-json > foo.cpuprofile
pyflame --flamechart [other pyflame options] | flame-chart-json > foo.cpuprofile

Read the following `Chrome DevTools article
<https://developers.google.com/web/updates/2016/12/devtools-javascript-cpu-profile-migration>`__
Expand Down
2 changes: 1 addition & 1 deletion src/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# flags, and frob3{4,6}.cc are compiled with python3.4/3.6 flags.

bin_PROGRAMS = pyflame
pyflame_SOURCES = aslr.cc frame.cc thread.cc namespace.cc posix.cc ptrace.cc pyflame.cc pyfrob.cc symbol.cc
pyflame_SOURCES = aslr.cc frame.cc thread.cc namespace.cc posix.cc prober.cc ptrace.cc pyflame.cc pyfrob.cc symbol.cc
pyflame_LDADD =

noinst_LTLIBRARIES =
Expand Down
Loading