Change Request: Distributed Tracing Support for FSPIOP API about mojaloop-specification HOT 10 CLOSED

@mdebarros and @elnyry-sam-k, as there have been no more comments regarding the change request, can you please go ahead and make a solution proposal containing the actual changes to the specification?

from mojaloop-specification.

from mojaloop-specification.

Thank you @mdebarros.

I'm OK with adding the W3C trace headers to the FSPIOP API as optional headers, making these the recommended way of adding traces. I don't want to make them mandatory to implement as would be the implication of the following part:

Participants are not required to do any additional processing of these tracing headers, but at a minimum, they should forward the tracing headers as part of FSPIOP call-back. This will ensure that there is an unbroken transactional trace from the switch to the FSP.

The FSPIOP API is a generic standard which could be used in a scheme where another Switch than the Mojaloop switch is used, or in a bilateral setup without a Switch, which is why I do not want these headers to be mandatory in the API. It should rather be the scheme rules that decides that these trace headers must be used within the scheme. Some schemes might choose to use other tracing mechanisms, or none at all. There should not be a requirement on implementers of the API to support them if they will not be used within a scheme as they are in no way required for the API to work.

Kind regards,
Henrik

from mojaloop-specification.

from mojaloop-specification.

Thanks @ehenrka , @jmssebunnya - agree with you; the goal is to add these to the Spec as optional and let Schemes decide on whether to make them required for that Scheme or not

from mojaloop-specification.

Thanks @ehenrka , sure

from mojaloop-specification.

I have proposed in the last SIG meetings to add the optional HTTP headers for tracing support to the existing version 1.1 of the API. This suggestion is related to my approved suggestion back in 2019 (email subject Open API for FSPIOP: Versioning of document and resources), where we decided to separate the document version and versions for different resources in the API.

As the tracing HTTP headers (traceparent, tracestate) are optional and does not need to be handled if they are received by an FSP, we should be able to safely add them to a new patch document version (1.1.1) of the API Definition document without any impact for existing implementations. There will be no changes to any of the resources of the API.

The suggestion then is to:

• Create a new table in Section 3.2.1.1 (HTTP Request Header Fields) to describe optional HTTP header fields, as the current Table 1 only describes HTTP headers that must be implemented.
• Add tracing HTTP headers (traceparent, tracestate) to the new table for optional HTTP headers and add reference to the Distributed Tracing Support for OpenAPI Interoperability document for detailed information.
• Update document version to new patch version 1.1.1, describe changes in Section 1.2

from mojaloop-specification.

Thanks Henrik (@ehenrka ) for the recommendations. We should be able to implement these and conclude this issue

from mojaloop-specification.

Please review #95, which contains the changes described in #71 (comment).

from mojaloop-specification.

Closing as supported since version 1.1.1

from mojaloop-specification.