Event Framework - Integrate into ML-API-Adapter

[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 for Prepare and Fulfil flows

Tasks:

• Event Framework
  • Enhance central services shared
    • Create a Hapi plugin with onPreAuth and onPreResponse to create a span per api request
    • Add to the README and jsdoc a description of the 'sampled' route tag for span creation
    • Integrate SDK for logging [ ? ]
      • ml-api-adapter - API
        • Integrate event-sdk
        • Configuration in default.json (e.g. sidecar enabled, logging mode etc) defer
        • Import NPM dependency
        • Make route ids more meaningful for the event i.e. ml_post_transfer, ml_put_transfer, ml_put_transfer_error
        • Add 'sampled' route tags
        • Integrate into health end-points for Event Sidecar (if sidecar is enabled) defer to Event, Auditing and Error Framework Design - Part III - Interlocks #834
        • Test events being Recorded into EFK
        • Logs (replace existing logs)
        • Add Audits for beginning of receiving request for Prepare, Fulfil, Errors, etc
        • Add Errors for both Internal (e.g. technical errors) and External (e.g. callback errors)
        • Traces for main span for Prepare, Fulfil, Errors, etc
        • Helm [ @mdebarros ]
          • Integrate event-sidecar into helm chart
          • Updated configuration for default.json in helm chart
      • ml-api-adapter - Notifications
        • Integrate event-sdk
        • Configuration in default.json (e.g. sidecar enabled, logging mode etc) defer
        • Integrate into health end-points for Event Sidecar (if sidecar is enabled) defer to Event, Auditing and Error Framework Design - Part III - Interlocks #834
        • Test events being Recorded into EFK
        • Logs (replace existing logs)
        • Add Audits for beginning of receiving request for Notifications
        • Add Errors for both Internal (e.g. technical errors - unable to get end-points from Central-Ledger, unable to send callback due to network) and External (e.g. callback resulted in an error from DFSP)
        • Traces for main span for Notifications
        • Helm [ @mdebarros ]
          • Integrate event-sidecar into helm chart
          • Updated configuration for default.json in helm chart
• Integration Testing (with ML-API-Adapter via side-car)
  • Test Log events (info, debug, error, etc) on EFK
  • Test Audit events on EFK
  • Test Trace events on APM

Acceptance Criteria:

• Designs are up-to-date
• Unit Tests pass
• 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 ML-API-Adapter for Prepare and Fulfil flows
  • Ensure that components cannot operate without Sidecar functioning correctly when enabled
  • Ensure that components will not startup without Sidecar when enabled
  • Sidecar can be disabled for local development and/or debugging purposes only
• Helm Charts
  • Deployment includes sidecar as part of deployment
  • Deployment includes sidecar configuration
• Recording of Events are correctly being captured
  • Logs events into EFK
  • Audit events into EFK
  • Trace events into APM (and EFK via APM)

Pull Requests:

• Feature/804integrate event framework central-services-shared#83
• Feature/804integrate event framework ml-api-adapter#163
• Release v8.1.0 (including event instrumentation) ml-api-adapter#190

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
• Event Framework - Event SDK Side-car implementation #874

Accountability:

• Owner: TBC
• QA/Review: TBC

[mdebarros]

Refer to draft design - https://github.com/mdebarros/documentation/blob/feature/%23767DesignEvent,AuditingandErrorFrameworkProposal/mojaloop-technical-overview/event-framework/README.md

[elnyry-sam-k]

Followed-up by #960