osprofiler config options don't show up in nova configuration reference

Bug #1774208 reported by Matt Riedemann
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Low
Matt Riedemann

Bug Description

Looking at the nova configuration reference and sample:

https://docs.openstack.org/nova/latest/configuration/config.html

The osprofiler options aren't included:

https://github.com/openstack/osprofiler/blob/master/osprofiler/opts.py

osprofiler is optional but if available we load the config options:

https://github.com/openstack/nova/blob/465051809c1f09417207136e2ac8615838262c1a/nova/config.py#L46

So we should probably include those in the configuration reference for nova. For example, we also include config options for the vmware driver which is optional, and oslo.vmware is in test-requirements.txt like osprofiler.

Tags: config docs
Changed in nova:
assignee: nobody → Matt Riedemann (mriedem)
status: Triaged → In Progress
Revision history for this message
Matt Riedemann (mriedem) wrote :
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/571225
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=dee92e6876cec8d3db23d54cccd7a1dec851a593
Submitter: Zuul
Branch: master

commit dee92e6876cec8d3db23d54cccd7a1dec851a593
Author: Matt Riedemann <email address hidden>
Date: Wed May 30 11:16:45 2018 -0400

    Add osprofiler config options to generated reference

    osprofiler is optional, but if it's installed we'll
    load up the configuration options from the library,
    but they weren't in the generated config sample so
    people would have to find the osprofiler docs, or
    worse the code, to figure out how to configure it.

    This simply adds the osprofiler config options to the
    nova config sample, which will also show up in the
    config reference docs.

    Change-Id: I28d35165ed77487cd49d560fb1eda4f1d640734e
    Closes-Bug: #1774208

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 18.0.0.0b3

This issue was fixed in the openstack/nova 18.0.0.0b3 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.