openstack/vitrage
Code Issues Proposed changes
b977d86a22
vitrage/doc/source/profiler-config.rst
Yujun Zhang 9b9e53d0a6 Add document about how configure and use profiler in vitrage 
Change-Id: I9e14d3846ac97412a2811f363b343d920d944b93
Implements: blueprint osprofiler-support
2017-07-25 14:55:36 +08: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