[RFE] Ironic is missing a header X-Openstack-Request-Id in API response

[Tan Lin]

In order to track operations cross projects, many services like Nova/Glance/Neutron/Cinder/Keystone have a such header with HTTP responsed. You can get this header from above projects by calling corresponding client with debug option.
Ironic should support this.
Step one: Ironic should add this header to API respond
Step two: Python-Ironicclient should save this header and return to caller.

Oslo team is working on oslo-incubation/apiclient/base.py to better support step two. See https://review.openstack.org/#/c/156508/19/specs/return-request-id.rst

[Ruby Loo (rloo)]

There is a BP: https://blueprints.launchpad.net/ironic/+spec/add-x-openstack-request-id-header to track this, so we don't need this bug. I'm going to mark this as invalid, if you think otherwise, change the status.

[Vladyslav Drok (vdrok)]

Copy of whiteboard contents:

Approving as the implementation should be simple, and the cross-project spec describes most of how this should work.
// jroll 2015-10-15

Addressed by: https://review.openstack.org/238008
    Add a new header 'x-openstack-request-id' to response

Gerrit topic: https://review.openstack.org/#q,topic:bp/add-x-openstack-request-id-header,n,z

[Jim Rollenhagen (jim-rollenhagen)]

Can we also be sure to put this request ID in every log? :)

[Tan Lin (tan-lin-good)]

ACK. Currently, Ironic log the request-id in some logs but not all, like async task(change_node_power_state) and periodic tasks (_sync_power_states). I will dig more to make it works.

[Jim Rollenhagen (jim-rollenhagen)]

@Tan, for async tasks this is due to the context not having the request ID; someone once taught me calling context.update_store() should pick that up.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/284520

[Tan Lin (tan-lin-good)]

Thanks to pint this, Jim. It works :)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/284520
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=add1884959bf5fc630584ceaa23a4293b6bd7da5
Submitter: Jenkins
Branch: master

commit add1884959bf5fc630584ceaa23a4293b6bd7da5
Author: Lin Tan <email address hidden>
Date: Thu Feb 25 11:20:40 2016 +0800

    Add ensure_thread_contain_context() to task_manager

    For async/periodic tasks, the context of local thread is missing.
    Set it with request context and this is useful to log the request_id
    in log messages.

    Change-Id: I436bc0512fcf493424f14e12a17c69f686455a4c
    Partial-Bug:#1505119

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/238008
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=4bf707d86af1e7500f2ceaf55523a4ad8e69250b
Submitter: Jenkins
Branch: master

commit 4bf707d86af1e7500f2ceaf55523a4ad8e69250b
Author: Lin Tan <email address hidden>
Date: Wed Oct 21 19:56:12 2015 +0800

    Append 'Openstack-Request-Id' header to the response

    This patch will append request_id to response headers. This is helpful
    for admin to track problems across projects.

    Accroding to OpenStack HTTP Header Guidelines, use
    'Openstack-Request-Id' instead of 'X-Openstack-Request-ID'.

    According the suggestions from API WG, a microversion is not needed here.

    Change-Id: Ica067aff19fe17052fcaf9c7384c9da7d1f7997d
    Partial-Bug: #1505119