Skip to content

Improve MergeService log messages

Stan Hu requested to merge sh-improve-merge-service-logging into master

What does this MR do and why?

This merge request changes two things:

  1. Include the application context in the log messages so that these merge info messages can be found by filtering by project, user, caller, etc.

  2. Previously if the merge were successful, merge_jid would be cleared out, and the log message would have a blank JID and just say:

Merge process finished on JID  with state merged

Now we retain the value before it gets cleared and use that.

Screenshots or screen recordings

Before (log/application_json.log)

{"severity":"INFO","time":"2022-10-06T07:33:02.922Z","correlation_id":"01GEP3CHFK5BZBDTGRQXAJR10G","message":"flightjs/Flight!10 - Git merge started on JID 5ff9227f0f716ba9b5726cb7"}
{"severity":"INFO","time":"2022-10-06T07:33:03.668Z","correlation_id":"01GEP3CHFK5BZBDTGRQXAJR10G","message":"flightjs/Flight!10 - Git merge finished on JID 5ff9227f0f716ba9b5726cb7 commit d6a711b1ec231e0b83b8c2543f4248701b959611"}
{"severity":"INFO","time":"2022-10-06T07:33:04.825Z","correlation_id":"01GEP3CHFK5BZBDTGRQXAJR10G","message":"flightjs/Flight!10 - Post merge started on JID 5ff9227f0f716ba9b5726cb7 with state locked"}
{"severity":"INFO","time":"2022-10-06T07:33:06.489Z","correlation_id":"01GEP3CHFK5BZBDTGRQXAJR10G","message":"flightjs/Flight!10 - Post merge finished on JID 5ff9227f0f716ba9b5726cb7 with state merged"}
{"severity":"INFO","time":"2022-10-06T07:33:06.758Z","correlation_id":"01GEP3CHFK5BZBDTGRQXAJR10G","message":"flightjs/Flight!10 - Merge process finished on JID  with state merged"}

After

{"severity":"INFO","time":"2022-10-06T08:02:17.883Z","correlation_id":"01GEP523C2W3X031TG6DWQ220S","meta.caller_id":"MergeWorker","meta.remote_ip":"127.0.0.1","meta.feature_category":"source_code_management","meta.user":"root","meta.project":"flightjs/Flight","meta.root_namespace":"flightjs","meta.client_id":"user/1","meta.root_caller_id":"Projects::MergeRequestsController#merge","merge_request_info":"flightjs/Flight!11","message":"flightjs/Flight!11 - Git merge started on JID 2fa1ba967cdf4123bcbe792f"}
{"severity":"INFO","time":"2022-10-06T08:02:18.332Z","correlation_id":"01GEP523C2W3X031TG6DWQ220S","meta.caller_id":"MergeWorker","meta.remote_ip":"127.0.0.1","meta.feature_category":"source_code_management","meta.user":"root","meta.project":"flightjs/Flight","meta.root_namespace":"flightjs","meta.client_id":"user/1","meta.root_caller_id":"Projects::MergeRequestsController#merge","merge_request_info":"flightjs/Flight!11","message":"flightjs/Flight!11 - Git merge finished on JID 2fa1ba967cdf4123bcbe792f commit edc657e89dede37e4be255c9fa2b118efe3a966d"}
{"severity":"INFO","time":"2022-10-06T08:02:18.981Z","correlation_id":"01GEP523C2W3X031TG6DWQ220S","meta.caller_id":"MergeWorker","meta.remote_ip":"127.0.0.1","meta.feature_category":"source_code_management","meta.user":"root","meta.project":"flightjs/Flight","meta.root_namespace":"flightjs","meta.client_id":"user/1","meta.root_caller_id":"Projects::MergeRequestsController#merge","merge_request_info":"flightjs/Flight!11","message":"flightjs/Flight!11 - Post merge started on JID 2fa1ba967cdf4123bcbe792f with state locked"}
{"severity":"INFO","time":"2022-10-06T08:02:19.892Z","correlation_id":"01GEP523C2W3X031TG6DWQ220S","meta.caller_id":"MergeWorker","meta.remote_ip":"127.0.0.1","meta.feature_category":"source_code_management","meta.user":"root","meta.project":"flightjs/Flight","meta.root_namespace":"flightjs","meta.client_id":"user/1","meta.root_caller_id":"Projects::MergeRequestsController#merge","merge_request_info":"flightjs/Flight!11","message":"flightjs/Flight!11 - Post merge finished on JID 2fa1ba967cdf4123bcbe792f with state merged"}
{"severity":"INFO","time":"2022-10-06T08:02:19.955Z","correlation_id":"01GEP523C2W3X031TG6DWQ220S","meta.caller_id":"MergeWorker","meta.remote_ip":"127.0.0.1","meta.feature_category":"source_code_management","meta.user":"root","meta.project":"flightjs/Flight","meta.root_namespace":"flightjs","meta.client_id":"user/1","meta.root_caller_id":"Projects::MergeRequestsController#merge","merge_request_info":"flightjs/Flight!11","message":"flightjs/Flight!11 - Merge process finished on JID 2fa1ba967cdf4123bcbe792f with state merged"}

Relates to #376699 (closed)

How to set up and validate locally

  1. Merge a merge request. 😄
  2. View log/application_json.log

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Stan Hu

Merge request reports