diff --git a/doc/source/contributor/profiler-config.rst b/doc/source/contributor/profiler-config.rst index c561e4e40..327cf6f84 100644 --- a/doc/source/contributor/profiler-config.rst +++ b/doc/source/contributor/profiler-config.rst @@ -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://: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 --connection-string=redis://:6379 .. image:: ./images/osprofiler-html-output.png :width: 100%