openstack/vitrage
Code Issues Proposed changes

Update profiler configuration with redis backend

Browse Source 
Change-Id: If961adee875699c5cb07f90951064b9701c52642
This commit is contained in:
Yujun Zhang 2017-08-14 14:26:51 +08:00
parent 43f7ea634c
commit 4ade92d95f
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/source/contributor/profiler-config.rst
View File

@ -15,17 +15,18 @@ Configuration
Profiling must be enabled **explicitly** in Vitrage configuration file::
[profiler]
enabled = true
hmac_keys = SECRET_KEY
#connection_string = messaging://
connection_string = redis://<ip-address>:6379/
- ``hmac_key`` will be used in client to sign a request with profiling enabled
- ``connection_string`` specify the storage driver to collect tracing data, default to ceilometer via messaging
- ``connection_string`` specify the storage driver to collect tracing data, fill in real IP address of redis here.
Please refer to `osprofiler user manual`_ for details
Note: in devstack environment, redis is available on ``redis://127.0.0.1:6379``.
Please refer to `osprofiler user manual`_ for details.
.. _osprofiler user manual: https://docs.openstack.org/osprofiler/latest/user/index.html
@ -38,11 +39,7 @@ Use ``--profile`` option in Vitrage CLI to send a request with profiling enabled
The key must match the `hmac_keys` configured in the server.
The uuid of trace will be prepended to the result::
To display trace use the command:
osprofiler trace show --html 8c2a594b-bb26-4a00-a408-fd378ae3566b
The uuid of trace will be prompted in console after the normal result. For example::
{
"directed": true,
@ -50,11 +47,15 @@ The uuid of trace will be prepended to the result::
"nodes": [],
"links": [],
"multigraph": true
}%
}
To display trace use the command:
osprofiler trace show --html 8c2a594b-bb26-4a00-a408-fd378ae3566b
Follow the help message above to show the trace file with ``osprofiler`` client::
osprofiler trace show --html 8c2a594b-bb26-4a00-a408-fd378ae3566b
osprofiler trace show --html <TRACE-ID> --connection-string=redis://<ip-address>:6379
.. image:: ./images/osprofiler-html-output.png
:width: 100%