Browse Source

[REF] profiler: update documentation + typo

- fix doc image path
pull/375/head
Pierre Verkest 10 years ago
committed by Moisés López
parent
commit
d4456e514a
No known key found for this signature in database GPG Key ID: F49F27BE918BFA35
  1. 38
      README.rst
  2. BIN
      doc/static/clear_stats.png
  3. BIN
      doc/static/dump_stats.png
  4. BIN
      doc/static/player.png
  5. BIN
      doc/static/start_profiling.png
  6. BIN
      doc/static/stop_profiling.png
  7. 8
      profiler/static/src/xml/player.xml

38
README.rst

@ -7,15 +7,15 @@ the standard ``cProfile`` into OpenERP/Odoo.
Basic usage
-----------
After installation, a new menu "Profiler" gets available in the
administration menu, with four items:
After installation, a player is add on the header bar, with
four items:
* Start profiling
* Stop profiling
* Dump stats: retrieve from the browser a stats file, in the standard
cProfile format (see Python documentation and performance wiki page
for exploitation tips).
* Clear stats
|player|
* Start profiling |start_profiling|
* Stop profiling |stop_profiling|
* Download stats: download stats file |dump_stats|
* Clear stats |clear_stats|
Advantages
----------
@ -27,6 +27,11 @@ module allows to do it in OpenERP context such that:
(although it could be pretty simple depending on the need)
* subtleties about threads are taken care of. In particular, the
accumulation of stats over several requests is correct.
* Quick access UI to avoid statistics pollution
* Use the standard cProfile format, see Python documentation and performance
wiki page for exploitation tips. Also do not miss `RunSnakeRun
<http://www.vrplumber.com/programming/runsnakerun/>`_ GUI tool to help you to
interpret it easly.
Caveats
-------
@ -39,10 +44,25 @@ Caveats
finish uninstalling.
* requests not going through web controllers are currently not taken
into account
* UI is currently quite crude, but that's good enough for now
Credit
------
Remotely inspired from ZopeProfiler, although there is no online
visualisation and there may never be one.
.. |player| image:: https://bytebucket.org/anybox/odoo_profiler/raw/default/doc/static/player.png
:alt: Player to manage profiler
.. |start_profiling| image:: https://bytebucket.org/anybox/odoo_profiler/raw/default/doc/static/start_profiling.png
:alt: Start profiling
:height: 35px
.. |stop_profiling| image:: https://bytebucket.org/anybox/odoo_profiler/raw/default/doc/static/stop_profiling.png
:alt: Stop profiling
:height: 35px
.. |dump_stats| image:: https://bytebucket.org/anybox/odoo_profiler/raw/default/doc/static/dump_stats.png
:alt: Download cprofile stats file
:height: 35px
.. |clear_stats| image:: https://bytebucket.org/anybox/odoo_profiler/raw/default/doc/static/clear_stats.png
:alt: Clear and remove stats file
:height: 35px

BIN
doc/static/clear_stats.png

After

Width: 277  |  Height: 58  |  Size: 8.2 KiB

BIN
doc/static/dump_stats.png

After

Width: 279  |  Height: 52  |  Size: 8.1 KiB

BIN
doc/static/player.png

After

Width: 76  |  Height: 30  |  Size: 1.5 KiB

BIN
doc/static/start_profiling.png

After

Width: 280  |  Height: 49  |  Size: 7.1 KiB

BIN
doc/static/stop_profiling.png

After

Width: 275  |  Height: 57  |  Size: 7.2 KiB

8
profiler/static/src/xml/player.xml

@ -2,16 +2,16 @@
<t t-name="profiler.player">
<div class="oe_topbar_item profiler_player">
<img class="profiler_enable"
title="Enable the profiler"
title="Start profiling"
src="/web/static/src/img/icons/gtk-media-record.png"/>
<img class="profiler_disable"
title="Disable the profiler"
title="Stop profiling"
src="/web/static/src/img/icons/gtk-media-pause.png"/>
<img class="profiler_clear"
title="Clean previous profiling"
title="Clear profiling"
src="/web/static/src/img/icons/gtk-media-stop.png"/>
<img class="profiler_dump"
title="Dump the previous profiling"
title="Download stats"
src="/web/static/src/img/icons/gtk-floppy.png"/>
</div>
</t>

Loading…
Cancel
Save