openstack/horizon
Code Issues Proposed changes

Merge "Tidy up the Profiler docs"

Browse Source
This commit is contained in:
Jenkins 2017-02-21 04:58:36 +00:00 committed by Gerrit Code Review
commit 4e0bd42d46
1 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/source/contributing.rst
View File

@ -104,28 +104,30 @@ merged to the master repository and it's time to celebrate!
Profiling Pages Profiling Pages
--------------- ---------------
In Ocata release of Horizon a new "OpenStack Profiler" panel is introduced within In the Ocata release of Horizon a new "OpenStack Profiler" panel was
a Developer dashboard. Once it is enabled and all prerequisites are set up, you introduced. Once it is enabled and all prerequisites are set up, you can see
can see what API calls Horizon actually makes when rendering a specific page. To which API calls Horizon actually makes when rendering a specific page. To
re-render the page while profiling it, you'll need to use "Profile" drop-down re-render the page while profiling it, you'll need to use the "Profile"
menu located left to the User menu in top right corner of the screen. In order to dropdown menu located in the top right corner of the screen. In order to
be able to use "Profile" menu the following steps need to be done: be able to use "Profile" menu, the following steps need to be completed:
#. Ensure that the Developer dashboard is enabled (copy _9001_developer.py file #. Enable the Developer dashboard by copying ``_9001_developer.py`` from
from the openstack_dashboard/contrib/developer/enabled folder into the ``openstack_dashboard/contrib/developer/enabled/`` to
openstack_dashboard/local/enabled folder if it is not already there). ``openstack_dashboard/local/enabled/``.
#. Copy openstack_dashboard/local/local_settings.d/_9030_profiler_settings.py.example #. Copy ``openstack_dashboard/local/local_settings.d/_9030_profiler_settings.py.example``
file to openstack_dashboard/local/local_settings.d/_9030_profiler_settings.py to ``openstack_dashboard/local/local_settings.d/_9030_profiler_settings.py``
#. Copy openstack_dashboard/contrib/developer/enabled/_9030_profiler.py to #. Copy ``openstack_dashboard/contrib/developer/enabled/_9030_profiler.py`` to
openstack_dashboard/local/enabled/_9030_profiler.py . ``openstack_dashboard/local/enabled/_9030_profiler.py``.
#. To support storing profiler data on server-side, MongoDB cluster needs #. To support storing profiler data on server-side, MongoDB cluster needs to be
to be installed on Devstack host (default configuration), see `Installing MongoDB`_. installed on your Devstack host (default configuration), see
Then, change net:bindIp: key to 0.0.0.0 inside /etc/mongod.conf and invoke `Installing MongoDB`_. Then, change the ``bindIp`` key in
``sudo service mongod restart`` for the changes to have an effect. ``/etc/mongod.conf`` to ``0.0.0.0`` and invoke
#. Re-collect and re-compress static assets. ``sudo service mongod restart``.
#. Re-start the production web-server in case you are serving Horizon from it. #. Collect and compress static assets with
``tox -e manage -- collecstatic -c`` and ``tox -e manage -- compress``
#. Restart the web server.
#. The "Profile" drop-down menu should appear in the top-right corner, you are #. The "Profile" drop-down menu should appear in the top-right corner, you are
ready to profile your pages! ready to profile your pages!
.. _installing MongoDB: https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/#install-mongodb-community-edition .. _installing MongoDB: https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/#install-mongodb-community-edition