python-openstackclient/releasenotes/notes/add-osprofiler-support-adf5286daf220914.yaml
Dina Belova 16f00833a7 Add shell --profile option to trigger osprofiler from CLI
This will allow to trigger profiling of various services that
allow it currently and which APIs support is added to openstackclient.
Cinder and Glance have osprofiler support already, Nova and Keystone
are in progress.

To use this functionality osprofiler (and its storage backend) needs
to be installed in the environment. If so, you will be able to trigger
profiling via the following command, for example:

$ openstack --profile SECRET_KEY user list

At the end of output there will be message with <trace_id>, and
to plot nice HTML graphs the following command should be used:

$ osprofiler trace show <trace_id> --html --out result.html

Related Keystone change: https://review.openstack.org/#/c/103368/
Related Nova change: https://review.openstack.org/#/c/254703/

The similar change to the keystoneclient
(https://review.openstack.org/#/c/255308/) was abandoned as new
CLI extenstions are not more accepted to python-keystoneclient.

Change-Id: I3d6ac613e5da70619d0a4781e5d066fde073b407
2016-02-25 20:13:27 +00:00

18 lines
945 B
YAML

---
features:
- |
OSprofiler support was added. To initiate OpenStack request tracing
``--profile <HMAC_KEY>`` option needs to be added to the CLI command. This
key needs to present one of the secret keys defined in the OpenStack
projects configuration files (if there is a wish to generate cross-project
trace, the chosen key needs to be presented in all these configuration
files). By default all OpenStack projects, that support OSprofiler,
are using ``SECRET_KEY`` HMAC key.
To use tracing functionality OSprofiler (and its storage backend)
needs to be installed in the environment. If so, you will be able to
trigger profiling via `openstack --profile SECRET_KEY <operation>` command.
At the end of output there will be message with <trace_id>, and to plot
human-readable HTML chart the following command should be used -
``osprofiler trace show <trace_id> --html --out result.html``.