Subject: | System Performance tracing, Event log and Audit improvements |
Summary: | LinkSOFT logs messages into the event log to keep the user informed. This case is about improving the logging messages and adding more messaging so the user is aware of all tasks. Design: We need to ensure that the Event Log is not overwhelmed with messages, at the same time, we need a good balance between useful information users and consultants can use for diagnostics and performance tuning. The following design is proposed: - Add a global setting at the Company level that flags if the event log should capture the Performance log
- In all procedures, we track the start and end time, then add a log entry if the time taken exceeds a pre-configured amount. This is especially important for processing functions
- Where possible, log 2. above with some data that users may find useful
- The log entry should be of the format:
- Message: Performance log. {Source}. {Processing Time(ms)}. {Summary Relevant Information}
- log data: JSON or plain text containing relevant information
|
Audit Notes: | Edited by sanjay on 05/08/21 11:25. Edited by sanjay on 23/07/21 11:54. Edited by sanjay on 23/07/21 11:54. Edited by alvis on 22/07/21 14:34. Edited by sanjay on 19/07/21 14:28. Edited by sanjay on 19/07/21 14:26. Edited by sanjay on 19/07/21 14:26. Edited by sanjay on 16/07/21 08:46. Edited by sanjay on 13/07/21 17:08. Edited by sanjay on 12/07/21 16:41. Edited by sanjay on 09/07/21 10:59. Edited by sanjay on 09/07/21 08:12. Edited by sanjay on 07/07/21 14:18. |
07 Jul 2021 | 02:18PM Comment 1 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 07-07-2021 05:20 PM Time Taken: 1.00 Notes: Edited by sanjay on 08/07/21 11:05. |
| Development Log: - Refactored procedure "LT_SYS_Log_Insert" to make "Consolidate" configurable
- Added new procedure "LT_SYS_Log_Event" to handle Event and performance entries
|
|
07 Jul 2021 | 02:18PM Comment 2 by Sanjay (Link Technologies) Case L12310 added to project 12.43 |
09 Jul 2021 | 08:12AM Comment 3 by Sanjay (Link Technologies) Case L12310 added to project 12.44 |
09 Jul 2021 | 10:58AM Comment 4 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 09-07-2021 02:57 PM Time Taken: 2.00 |
| Nest Step: - Determine where to store logging configuration
- Apply event logging in critical functions
- Add event logging to framework
|
|
09 Jul 2021 | 10:59AM Comment 5 by Sanjay (Link Technologies) ETC was changed from 31/07/2021 to 31/07/2021 |
13 Jul 2021 | 05:08PM Comment 6 by Sanjay (Link Technologies) Case L12310 added to project 12.45 |
14 Jul 2021 | 01:38PM Comment 7 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 16-07-2021 02:19 PM Time Taken: 2.00 Notes: ETC extended from: 31/07/2021 to 16/07/2021 |
| Investigating a design that will add value to logging. The objective is to read the log to see if there are any issues with the system. To achieve this, we need to know the following: - What process has been initiated
- When it was completed and how long it took
- Any errors raised by the process
Next step: - Find a way to prevent flooding the event log. We need to consider that man processes are schedules and will not perform any action.
- How do we cleanup logs - maybe add this as part of the maintenance cleanup process.
|
|
15 Jul 2021 | 04:37PM Comment 8 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 15-07-2021 08:32 PM Time Taken: 7.00 |
| The following changes were implemented - "Global Administration ~> Event Log" View option?
- "Global Administration ~> Database Backup" - Added Detailed logging and Log views
- "Global Administration ~> Company" - Added DELETE and UPDATE logging. Added Log view.
- "Global Administration ~> Audit Setup" - Added DELETE and UPDATE logging. Added Log view.
|
|
15 Jul 2021 | 05:45PM Comment 9 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 15-07-2021 08:37 PM Time Taken: 4.00 |
| The following changes were implemented - "Global Administration ~> Event Log" View option?
- Adde user account change logging at all of the following points:
- User created
- User logged in
- User password reset
- Add/Remove roles from a user
- Unlock a user
|
|
16 Jul 2021 | 08:51AM Comment 10 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 16-07-2021 12:46 PM Time Taken: 4.00 |
| Added Event Logging for the following: - User maintenance
- Create User
- Recover Password
- User Login
- TFA email
- Add/Remove User Role
- Add/Remove User access to company
- Change in Workflow
- Reset password
|
|
16 Jul 2021 | 05:06PM Comment 11 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 19-07-2021 12:51 PM Time Taken: 18.00 |
| Added logging to the following: - Additional Fields/Rule - Added column IsUsed and Allow user to remove field and contents
- Added logging to Additional Field/Rule DELETE
- Added logging for "Company Administration ~> Processes". Changes in Process, Process Rules and Process Execution
- Added Analysis computation so that Processes can average the last 10 executions instead of just the longest run time
- Added Event logging for Organisation User List
- Added Event logging for Configuration
- Added Event logging for Integration Setup
- Added Event logging for Email Log and Email Report log
|
|
19 Jul 2021 | 02:26PM Comment 12 by Sanjay (Link Technologies) ETC was changed from 16/07/2021 to 16/07/2021 |
21 Jul 2021 | 10:19AM Comment 13 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 21-07-2021 02:14 PM Time Taken: 4.00 |
| Added logging in Database Utility to show the following: - Creating a new database
- Start Upgrading
- Finish Upgrading
- User stops upgrade script process
|
|
22 Jul 2021 | 02:34PM Comment 14 by Alvis (Link Technologies) Case L12310 added to project 12.51 |
03 Aug 2021 | 10:42AM Comment 15 by Sanjay (Link Technologies) Assigned To: Rashna (Edge Business Solutions) Followup Date: 06-08-2021 02:41 PM Time Taken: 1.00 Notes: ETC extended from: 16/07/2021 to 06/08/2021 |
| Further work will be done in the next release. Proceed to test the areas that we have completed. |
|
05 Aug 2021 | 11:25AM Comment 16 by Sanjay (Link Technologies) ETC was changed from 06/08/2021 to 06/08/2021 |
05 Aug 2021 | 01:54PM Comment 17 by Sanjay (Link Technologies) Assigned To: Sanjay (Link Technologies) Followup Date: 05-08-2021 05:21 PM Time Taken: 4.00 |
|
The following tests were performed: Table 1 - Test Results
# | Test Case Details | Pass/Fail | Comments | 1 | Menu: Global Administration ~> Company.
| Pass
| Changes visible using the "Log" link
| 2 | Menu: Global Administration ~> Audit Setup
| Pass
| Changes visible using the "Log" link
| 3 | Menu: Global Administration ~> User Maintenance
| Pass
| Changes visible using the "Log" link
| 4 | Menu: Global Administration ~> Additional Fields/Rules
| Pass
| Can delete Unused items after setting it to Void
| 5 | Menu: "Company Administration ~> Processes"
| Pass
| Changes visible using the "Log" link
| 6 | Analysis computation so that Processes can average the last 10 executions instead of just the longest run time
| Pass
| Processes show an average of the last 10 execution times where executions > 1sec
| 7 | Event logging for Organisation User List
| Pass
| Changes visible using the "Log" link
| 8 | Event logging for Configuration
| Pass
| Changes visible using the "Log" link
| 9
| Event logging for Integration Setup
| Pass
| Changes visible using the "Log" link
| 10
| Event logging for Email Log and Email Report log
| Pass
| Changes visible using the "Log" link Delete Email is logged Delete Report is logged | 11
| Added logging in Database Utility to show the following: - Creating a new database
- Start Upgrading
- Finish Upgrading
- The user stops the upgrade script process
| Pass
| Logs can be viewed in the Event Log | Environment Details - Application version: 12.51
- Setup on:
- Server: LinkQA4
- Database: DEV-LinkSOFT
- LinkSOFT URL: HTTP://10.0.0.14/DEV-LinkSOFT
- Login Details: Standard username and password for user "admin"
|
|