m6web/xrequestuid-bundle

bundle sf2 allowing setting ids in headers propagated via guzzle

XRequestUidBundle

For implementation into a Symfony 3 or Symfony 4 application, please use the release v3.0.0 at least., _(*1)

Why ?

"The cool thing in microservices is that you can generate 15 http calls in your infrastructure just with on client http call", _(*2)

, _(*3)

This situation leads to many difficulties to trace calls betweens APIs systems, especially when an internal call fails. This bundle provide a solution to generate ids for new requests and configure your guzzle services accordingly to uses those ids in sub http requests made by them., _(*4)

The bundle will generate and/or forward those two headers : X-Request-Uid and X-Request-Parent-Uid., _(*5)

How ?

When a request arrive, if a X-Request-Id exists, it is copied into the X-Request-Parent-Id. If it's dont exist we generate it throught the uniqId_service., _(*6)

All your guzzle services are decorated with a proxy who will add the two headers in all the call made., _(*7)

At the end both headers are added to the response for debugging purpose., _(*8)

, _(*9)

You can now add thoses two headers in your logs file and follow the calls., _(*10)

Configuration

m6_web_x_request_uid:
    request_uid_header_name: X-Request-toto    # optionnal, X-Request-Uid by default
    request_parent_uid_header_name: X-Parent   # optionnal, X-Request-Parent-Uid by default 
    uniqId_service: myservice                  # optionnal, a service implementing UniqIdInterface 
    services:                                  # list of guzzle services to decorate 
        - test.guzzle1

services:
    test.guzzle1:
        class: 'GuzzleHttp\Client'

If you have other bundles creating guzzle services, be sure to add the bundle after them in your AppKernel file., _(*11)

You can define you own uniqId service or juste use the one provided in the bundle (wich do a basic php uniqid)., _(*12)

Related

• Use The GuzzleHttp Bundle to instanciate your guzzle services.
• Use the LogBridge Bundle to see responses when a problem occurs.

Todo

• add more tests
• add more docs