OSProfiler Support

OSProfiler Support

https://blueprints.launchpad.net/vitrage/+spec/osprofiler-support

OSProfiler is an OpenStack cross-project profiling library. It allows user to generate 1 trace per request which is processed in multiple services.

Problem description

It is quite common that Vitrage is integrated in a large system to provide a complete solution e.g. as inspector in OPNFV/Doctor for fault management.

When performance is a critical issue, it is very complicated to analyse the event processing workflow and locate the bottleneck in case something works slowly.

Proposed change

Add osprofiler support in vitrage and vitrage-client.

OSProfiler will help to generate a tree of calls (see example) which is intuitive to understand what exactly is going on.

Alternatives

Explained in why not cprofile and etc

Data model impact

None

REST API impact

Additional HTTP header inserted by profiler should be checked when it is enabled. Besides that, there is no impact on the business logic in api handler.

Versioning impact

None

Other end user impact

None

Deployer impact

None

Developer impact

None

Horizon impact

None

Implementation

Assignee(s)

Primary assignee:
yujunz
Other contributors:
None

Work Items

  • add configuration options for osprofiler
  • add initialization of osprofiler in service startup
  • add osprofiler wsgi middleware to trace HTTP calls
  • trace RPC calls

Refer to the changes proposed in similar topic in ironic for an overview.

Dependencies

None

Testing

Covered by unit test.

Documentation Impact

Add to developer guide on how to use osprofiler.

References

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

vitrage-specs