| 1 |
--- |
| 2 |
fixes: |
| 3 |
- Missing OSprofiler support was added. This cross-project profiling library |
| 4 |
allows to trace various OpenStack requests through all OpenStack |
| 5 |
services that support it. To initiate OpenStack |
| 6 |
request tracing `--profile <HMAC_KEY>` option needs to be added to |
| 7 |
the CLI command. This key needs to present one of the secret keys |
| 8 |
defined in neutron.conf configuration file with `hmac_keys` option |
| 9 |
under the `[profiler]` configuration section. To enable or disable |
| 10 |
Neutron profiling the appropriate `enabled` option under the same |
| 11 |
section needs to be set either to `True` or `False`. By default |
| 12 |
Neutron will trace all API and RPC requests, but there is an opportunity |
| 13 |
to trace DB requests as well. For this purpose `trace_sqlalchemy` |
| 14 |
option needs to be set to `True`. As a prerequisite OSprofiler |
| 15 |
library and its storage backend needs to be installed to the |
| 16 |
environment. If so (and if profiling is enabled in neutron.conf) |
| 17 |
the trace can be generated via command - |
| 18 |
`$ neutron --profile SECRET_KEY <subcommand>`. |
| 19 |
At the end of output there will be message with <trace_id>, and |
| 20 |
to plot nice HTML graphs the following command should be used - |
| 21 |
`$ osprofiler trace show <trace_id> --html --out result.html` |
| 22 |
upgrade: |
| 23 |
- OSprofiler support was introduced. To allow its usage the api-paste.ini |
| 24 |
file needs to be modified to contain osprofiler middleware. Also |
| 25 |
`[profiler]` section needs to be added to the neutron.conf file with |
| 26 |
`enabled`, `hmac_keys` and `trace_sqlalchemy` flags defined. |
| 27 |
security: |
| 28 |
- OSprofiler support requires passing of trace information |
| 29 |
between various OpenStack services. This information is |
| 30 |
securely signed by one of HMAC keys, defined in neutron.conf configuration |
| 31 |
file. To allow cross-project tracing user should use the key, that is |
| 32 |
common among all OpenStack services he or she wants to trace. |