openstack/vitrage
Code Issues Proposed changes
881b04e793
vitrage/doc/source/contributor/profiler-config.rst
Ifat Afek b27a29fde3 Some documentation changes 
- Added missing documentation of Nova notifier
- Moved osprofiler doc under contributor folder
- Marked the static-physical datasource as obsolete
- Removed a link to Aodh notifier (the document was deleted, as it was just a POC)

Depends-On: Ifcde995130486c859e6a9ce23e47a89910187732
Change-Id: Ib2b7880d65d4c6edd7cfd1f831da9da7af5e114c
2017-07-30 11:58:32 +00:00

1.5 KiB
Raw Blame History

Configure profiler

Overview

osprofiler, the Cross-project profiling library for OpenStack, is integrated in Vitrage to generate 1 trace per request, that goes through all involved services.

Configuration

Profiling must be enabled explicitly in Vitrage configuration file:

[profiler]

enabled = true
hmac_keys = SECRET_KEY
#connection_string = messaging://
  • 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

Please refer to osprofiler user manual for details

Usage

Use --profile option in Vitrage CLI to send a request with profiling enabled, e.g.:

vitrage --profile SECRET_KEY topology show

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

{
  "directed": true,
  "graph": {},
  "nodes": [],
  "links": [],
  "multigraph": true
}%

Follow the help message above to show the trace file with osprofiler client:

osprofiler trace show --html 8c2a594b-bb26-4a00-a408-fd378ae3566b

image