Add RequestId to all logged events

[martha-garasky]

In order better follow the lifecycle of a triggered message, can we add the requestId from the trigger event into all logged events. Making this a configurable option also is ok.

So a log would go from looking like this: 2023-04-09 21:44:27.740 ERROR 1 --- [pool-1-thread-2] c.d.b.e.s.i.EhrFhirR4QueryServiceImpl : No entries found for type : MedicationRequest

to something like this: 2023-04-09 21:44:27.740 ERROR 1 --- [pool-1-thread-2] c.d.b.e.s.i.EhrFhirR4QueryServiceImpl : RequestId: <id> -- No entries found for type : MedicationRequest

This additional item in the log message will help making parsing easier when using external logging tools such as splunk.

[nbashyam]

Will consider it for a future sprint.

[kmarx]

I'd like to upvote this. Wherever the x-request-id or correlation-id are available, they should be logged. In addition to the rationale provided by @martha-garasky, our EHR has multiple practices and this would allow us to track volume and load with better granularity since we bake the practice id into the x-request-id.

I'd also like to add a request that logging be more complete for other use cases even when x-request-id isn't in scope. E.g.,

• Getting IMAP direct message logging should include the to/from addresses (as is already done for `Sending Mail from ecrnow@ourehr.com to ecr-prod@direct.aimsplatform.org
• Any other send/receive transport logging. Such as Connecting to IMAP Inbox - should indicate which direct address is being logged in with.
• All scheduled job logging should include the (admittedly very long) task_instance id. E.g., "Error in completing the Execution, retry in 5 minutes
• Note that some of the logging in ScheduleJobConfiguration is also missing the x-request-id and should be added per OP's request
• eICR Validation errors. E.g., ARN c.d.cda.utils.ValidateErrorHandler LINE[35] - Message: Error validating XML Data at Line: 3211 Column: 64 Message: cvc-pattern-valid: Value....

[nbashyam]

We have added xRequestId to start / end of the task execution, so all messages from the thread within that context is for the same request id. Currently it is not possible to change each log statement to add xRequestId.