Description:
Currently users can use the custom log message functionality to write a log entry when they start an operation.
The entry contains an ID that identifies the user's session.
The users can then use the same function to write a closing custom log message when the process is finished.
The closing log message does not contain any ID that identifies the user's session.
If multiple users are using the custom log functionality then it can be difficult to link the messages together.
Also the start/closing messages could be stored in different log files.
This enhancement is to increase the amount of information that is logged using this functionality.
This is the start message that is displayed and it contains the UI correlation ID.
[27/04/23 12:35:11:507 BST] 000000f5 SystemOut O 27 Apr 2023 12:35:11:506 [INFO] [MXUI1] [] BMXAA8871I - Start of the custom log message. The UI correlation ID for this logging session is 1027.
FUNCTION DELETING A PM
This is the current end message that is logged and it does not contain the UI correlation ID.
[27/04/23 12:41:09:180 BST] 000000f3 SystemOut O 27 Apr 2023 12:41:09:180 [INFO] [MXUI1] [] BMXAA8872I - End of the custom log message.
STOP MESSAGE - FUNCTION DELETING A PM
The request contains several parts:
1 - Log the UI correlation ID in the final message.
The revised version would look like this:
[27/04/23 12:41:09:180 BST] 000000f3 SystemOut O 27 Apr 2023 12:41:09:180 [INFO] [MXUI1] [] BMXAA8872I - End of the custom log message. The UI correlation ID for this logging session is 1027.
STOP MESSAGE - FUNCTION DELETING A PM
2.1 - Log any information about the user who logged the message e.g. USERID. This needs to be included in the start message
[27/04/23 12:35:11:507 BST] 000000f5 SystemOut O 27 Apr 2023 12:35:11:506 [INFO] [MXUI1] [] BMXAA8871I - Start of the custom log message. The UI correlation ID for this logging session is 1027. UserID: JBLOGGS
FUNCTION DELETING A PM
2.2 - Log any information about the user who logged the message e.g. USERID. This needs to be included in the closing message
[27/04/23 12:41:09:180 BST] 000000f3 SystemOut O 27 Apr 2023 12:41:09:180 [INFO] [MXUI1] [] BMXAA8872I - End of the custom log message. The UI correlation ID for this logging session is 1027. UserID: JBLOGGS
STOP MESSAGE - FUNCTION DELETING A PM
3 - Include the time of the first message in the closing message.
[27/04/23 12:41:09:180 BST] 000000f3 SystemOut O 27 Apr 2023 12:41:09:180 [INFO] [MXUI1] [] BMXAA8872I - End of the custom log message. The UI correlation ID for this logging session is 1027. UserID: JBLOGGS Start time: 27 Apr 2023 12:35:11:506 Interval: <time in seconds between the start/end times>
STOP MESSAGE - FUNCTION DELETING A PM
This would speed up support investigations by providing key information that isn't currently available.
This functionality will become more valuable as more people become aware of the options.