Company: Link Technologies
Case No: L12310. Project: 12.51: LinkSOFT version 12.51
Logged By: Sanjay (Link Technologies) on 07 Jul 2021 02:18PM
Priority: High
Product: Framework
Group: New Feature
Time Taken: 47.00 (Weight: 60.00)
Version: 12.51.0813
Assigned To: Sanjay (Link Technologies)
Circulation: Alvis, Rashna, Sanjay
Resolve By: Friday, 06 August 2021 11:59 PM [1016 days since logged date]
Status: Closed
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:

  1. Add a global setting at the Company level that flags if the event log should capture the Performance log
  2. 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
  3. Where possible, log 2. above with some data that users may find useful
  4. The log entry should be of the format:
    1. Message: Performance log. {Source}. {Processing Time(ms)}. {Summary Relevant Information}
    2. 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 202102: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:

  1. Refactored procedure "LT_SYS_Log_Insert" to make "Consolidate" configurable
  2. Added new procedure "LT_SYS_Log_Event" to handle Event and performance  entries

07 Jul 202102:18PM Comment 2 by Sanjay (Link Technologies) Case L12310 added to project 12.43
09 Jul 202108:12AM Comment 3 by Sanjay (Link Technologies) Case L12310 added to project 12.44
09 Jul 202110: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:

  1. Determine where to store logging configuration
  2. Apply event logging in critical functions
  3. Add event logging to framework 

09 Jul 202110:59AM Comment 5 by Sanjay (Link Technologies) ETC was changed from 31/07/2021 to 31/07/2021
13 Jul 202105:08PM Comment 6 by Sanjay (Link Technologies) Case L12310 added to project 12.45
14 Jul 202101: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:
  1. What process has been initiated
  2. When it was completed and how long it took
  3. Any errors raised by the process

Next step:

  1. Find a way to prevent flooding the event log. We need to consider that man processes are schedules and will not perform any action.
  2. How do we cleanup logs - maybe add this as part of the maintenance cleanup process.



15 Jul 202104: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

  1. "Global Administration ~>  Event Log" View option?
  2. "Global Administration ~>  Database Backup" - Added Detailed logging and Log views
  3. "Global Administration ~> Company" - Added DELETE and UPDATE logging. Added Log view.
  4. "Global Administration ~> Audit Setup" - Added DELETE and UPDATE logging. Added Log view.

15 Jul 202105: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

  1. "Global Administration ~>  Event Log" View option?
  2. Adde user account change logging at all of the following points:
    1. User created
    2. User logged in
    3. User password reset
    4. Add/Remove roles from a user
    5. Unlock a user

16 Jul 202108: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:

  1. User maintenance
    1. Create User
    2. Recover Password
    3. User Login
    4. TFA email
    5. Add/Remove User Role
    6. Add/Remove User access to company
    7. Change in Workflow
    8. Reset password

16 Jul 202105: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:

  1. Additional Fields/Rule - Added column IsUsed and Allow user to remove field and contents
  2. Added logging to Additional Field/Rule DELETE
  3. Added logging for "Company Administration ~> Processes". Changes in Process, Process Rules and Process Execution
  4. Added Analysis computation so that Processes can average the last 10 executions instead of just the longest run time
  5. Added Event logging for Organisation User List
  6. Added Event logging for Configuration
  7. Added Event logging for Integration Setup
  8. Added Event logging for Email Log and Email Report log

19 Jul 202102:26PM Comment 12 by Sanjay (Link Technologies) ETC was changed from 16/07/2021 to 16/07/2021
21 Jul 202110: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:

  1. Creating a new database
  2. Start Upgrading
  3. Finish Upgrading
  4. User stops upgrade script process

22 Jul 202102:34PM Comment 14 by Alvis (Link Technologies) Case L12310 added to project 12.51
03 Aug 202110: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 202111:25AM Comment 16 by Sanjay (Link Technologies) ETC was changed from 06/08/2021 to 06/08/2021
05 Aug 202101: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 DetailsPass/FailComments
1Menu: Global Administration ~> Company. 
Pass
Changes visible using the "Log" link
2Menu: Global Administration ~> Audit Setup
Pass
Changes visible using the "Log" link
3Menu: Global Administration ~> User Maintenance
Pass
Changes visible using the "Log" link
4Menu: 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:

  1. Creating a new database
  2. Start Upgrading
  3. Finish Upgrading
  4. The user stops the upgrade script process
Pass
Logs can be viewed in the Event Log

Environment Details

  1. Application version: 12.51
  2. Setup on:
    1. Server: LinkQA4
    2. Database: DEV-LinkSOFT
    3. LinkSOFT URL: HTTP://10.0.0.14/DEV-LinkSOFT
  3. Login Details: Standard username and password for user "admin"

If you have any queries regarding this support incident, please email admin@linktechnologies.com.au and include the Case No: L12310 in the subject line of all emails regarding this issue.

Document size: 15.0 KB
For call complaints, please contact the Managing Director of the company using this form