Event Framework - Integrate into Quoting-Service

[mdebarros]

Goal:

As a Hub Operator I want to integrate Event Framework into Mojaloop components so that so that all events (errors, general, etc) can be audited and traced appropriately

Tasks:

• Explore the current integration of event-sdk with central-ledger and ml-api adapter [@ggrg]
  • Introduction with @ndonnan [@ggrg]
  • Setup vpn [@ggrg]
  • Local setup for pushing to dev1-efk [@ggrg]
  • Local setup of quoting-service, working with simulator to send quoteResponse [@ggrg]
  • Explore event-sdk, event-sidecar, event-stream-processor [@ggrg]
  • Explore related PRs (Feature/804integrate event framework central-ledger#375, Release v8.1.0 (including event instrumentation) ml-api-adapter#190) [@ggrg]
• Event Framework
  • Integrate SDK for logging
  • quoting-service
    • Extend hapi-openapi for use with CentralServices.Util.Hapi.HapiEventPlugin [@ggrg]
    • Integrate event-sdk [@ggrg]
    • Configuration in default.json (e.g. sidecar enabled, logging mode etc)
    • Import NPM dependency [@ggrg]
    • Integrate into health end-points for Event Sidecar (if sidecar is enabled)
    • Recording
      • Logs (replace existing logs)
      • Add Audits for beginning of receiving request for quotes [@ggrg]
      • Handle Errors (for both Internal vs External) [@ggrg]
      • Traces for main span for quotes, etc [@ggrg]
  • Simulator
    • Ensure that simulator is able to process and respond with trace headers for Quoting operations [@ggrg]
    • Implement trace header handling on GET Quotes operation (this has not been implemented as part of the original PR) [@ggrg] <-- GET /payerfspORpayeefsp/quotes/{id} is not implemented at all, so this is rather a separate simulator story (Implement GET /quotes on the simulator to support event framework testing / demos on quoting-service #1028)
  • Remaining tasks
    • Get PR review for event-sdk, merge & release [@ggrg, @vgenev, @mdebarros]
    • Provide unit tests coverage for central-services-shared [@ggrg]
    • Upgrade central-services-shared to use latest event-sdk [@ggrg]
    • Get PR review for central-services-shared, merge & release [@ggrg]
    • Upgrade LibUtil.getSpanTags for PUT and GET [@ggrg]
    • Fix unit tests for quoting service [@ggrg]
      • Add a story for addressing quoting-service setImmediate calls in unit testing (Address quoting-service setImmediate calls in unit testing #1027 )
    • Upgrade dependencies [@ggrg]
    • Verify newly implemented functionality with story owner [@ggrg, @mdebarros]
    • Get PR review for quoting-service, merge & release [@ggrg]
  • Helm
    • Integrate event-sidecar into helm chart Helm Release v8.4.0: Support QA, Fixes, Releases, etc #1015
    • Updated configuration for default.json in helm chart Helm Release v8.4.0: Support QA, Fixes, Releases, etc #1015

Acceptance Criteria:

• Designs are up-to-date
• Unit Tests pass
• Integration Tests pass
• Code Style & Coverage meets standards
• Changes made to config (default.json) are broadcast to team and follow-up tasks added to update helm charts and other deployment configs.
• Event Framework integrated into Quoting-Service
  • Ensure that components cannot operate without Sidecar functioning correctly when enabled
  • Ensure that components will not startup without Sidecar when enabled Event, Auditing and Error Framework Design - Part III - Interlocks #834
  • Sidecar can be disabled for local development and/or debugging purposes only
• Helm Charts
  • Deployment includes sidecar as part of deployment Helm Release v8.4.0: Support QA, Fixes, Releases, etc #1015
  • Deployment includes sidecar configuration Helm Release v8.4.0: Support QA, Fixes, Releases, etc #1015

Pull Requests:

• hotfix/sendRequest method not returning http response simulator#87
• Feature/Support for custom operation tags krakenjs/hapi-openapi#164 --> Update: v1.2.4 released
• Feature/827 Integrate Event Framework central-ledger#445
• Feature/827 Integrate Event Framework event-sdk#13
• Feature/827 Integrate Event Framework central-services-shared#121
• Feature/827 Integrate Event Framework quoting-service#70

Follow-up:

• N/A

Dependencies:

• Event Framework - Event SDK Client & Server Implementation (part II) #823
• Event Framework - Helm Charts - Update EFK to include APM #791

Accountability:

• Owner: @mdebarros
• QA/Review: TBC

[ggrg]

When running event-sidecar locally with default config on MacOS Catalina I'm getting the following output:

2019-10-16T13:55:36.966Z - info: GRPC Server started at host: localhost, port: 50051
E1016 16:55:36.969858000 4358815040 server_chttp2.cc:40]               {"created":"@1571234136.969818000","description":"No address added out of total 2 resolved","file":"../deps/grpc/src/core/ext/transport/chttp2/server/chttp2_server.cc","file_line":394,"referenced_errors":[{"created":"@1571234136.969802000","description":"Failed to add port to server","file":"../deps/grpc/src/core/lib/iomgr/tcp_server_custom.cc","file_line":404,"referenced_errors":[{"created":"@1571234136.969797000","description":"Failed to listen to port","file":"../deps/grpc/src/core/lib/iomgr/tcp_uv.cc","file_line":72,"grpc_status":14,"os_error":"address already in use"}]},{"created":"@1571234136.969816000","description":"Failed to add port to server","file":"../deps/grpc/src/core/lib/iomgr/tcp_server_custom.cc","file_line":404,"referenced_errors":[{"created":"@1571234136.969816000","description":"Failed to listen to port","file":"../deps/grpc/src/core/lib/iomgr/tcp_uv.cc","file_line":72,"grpc_status":14,"os_error":"address already in use"}]}]}
2019-10-16T13:55:36.970Z - info: Server listening on localhost:50051...

Please note: "grpc_status":14,"os_error":"address already in use"
It turned out launchd is using port 50051, so I needed to change EVENT_LOGGER_GRPC_PORT locally to another port (e.g. 50055) to run the service successfully.