[IGBF-3556] Save IGB logs to file in .igb folder - JIRA UNCC

Details

Type: Improvement
Status: Closed (View Workflow)
Priority: Major
Resolution: Done
Affects Version/s: None
Fix Version/s: None
Labels:
None

Story Points:
5
Epic Link:
Improve IGB for developers
Sprint:
Spring 4, Spring 5

Description

Situation: The IGB logger is helpful in identifying issues/problems. However, if IGB crashes there is no record of the log.

Task: Write the current/last IGB log to a file such that if IGB crashes a user can obtain and view the log to see if there are any warnings/errors that could indicate why IGB crashed. Preference would be for the log file to be saved to the IGB installation directory.

Attachments

Activity

Ascending order - Click to sort in descending order

Nowlan Freese created issue - 23/Jan/24 9:40 AM

Nowlan Freese made changes - 23/Jan/24 9:40 AM

Field	Original Value	New Value
Epic Link		IGBF-1531 [ 17617 ]

Nowlan Freese made changes - 21/Feb/24 11:59 AM

Assignee

Kaushik Gopu [ kgopu ]

Nowlan Freese made changes - 21/Feb/24 11:59 AM

Description	Situation: The IGB logger is helpful in identifying issues/problems. However, if IGB crashes there is no record of the log. Task: Write the current/last IGB log to a file in the .igb folder such that if IGB crashes a user can obtain and view the log to see if there are any warnings/errors that could indicate why IGB crashed.	Situation: The IGB logger is helpful in identifying issues/problems. However, if IGB crashes there is no record of the log. Task: Write the current/last IGB log to a file such that if IGB crashes a user can obtain and view the log to see if there are any warnings/errors that could indicate why IGB crashed. Preference would be for the log file to be saved to the IGB installation directory.
Sprint		Spring 4 [ 188 ]

Nowlan Freese made changes - 26/Feb/24 10:12 AM

Status

To-Do [ 10305 ]

In Progress [ 3 ]

Hide

Permalink

Kaushik Gopu added a comment - 28/Feb/24 10:25 AM

logback: https://logback.qos.ch/documentation.html

Show

Kaushik Gopu added a comment - 28/Feb/24 10:25 AM logback: https://logback.qos.ch/documentation.html

Ann Loraine made changes - 04/Mar/24 9:41 AM

Sprint

Spring 4 [ 188 ]

Spring 4, Spring 5 [ 188, 189 ]

Ann Loraine made changes - 04/Mar/24 9:41 AM

Rank

Ranked higher

Hide

Permalink

Kaushik Gopu added a comment - 04/Mar/24 12:06 PM

Implemented file appender to capture the IGB logs.
Added View Logs button to the log panel of the IGB.

Test Instructions

Test the functionality in all the OS and check if the log file opens when you hit the "View Logs" button.
Run IGB multiple times (at least 2) and verify whether the logs belong to the current session (check timestamp).
Changes available in this branch.

Show

Kaushik Gopu added a comment - 04/Mar/24 12:06 PM Implemented file appender to capture the IGB logs. Added View Logs button to the log panel of the IGB. Test Instructions Test the functionality in all the OS and check if the log file opens when you hit the "View Logs" button. Run IGB multiple times (at least 2) and verify whether the logs belong to the current session (check timestamp). Changes available in this branch.

Kaushik Gopu made changes - 04/Mar/24 12:09 PM

Status

In Progress [ 3 ]

Needs 1st Level Review [ 10005 ]

Hide

Permalink

Ann Loraine added a comment - 04/Mar/24 5:24 PM - edited

Additional test instruction:

On Mac, simulate a crash by using Apple > Force Quit menu.

Show

Ann Loraine added a comment - 04/Mar/24 5:24 PM - edited Additional test instruction: On Mac, simulate a crash by using Apple > Force Quit menu.

Nowlan Freese made changes - 06/Mar/24 10:37 AM

Assignee

Kaushik Gopu [ kgopu ]

Nowlan Freese made changes - 08/Mar/24 9:49 AM

Status

Needs 1st Level Review [ 10005 ]

First Level Review in Progress [ 10301 ]

Hide

Permalink

Nowlan Freese added a comment - 11/Mar/24 2:57 PM - edited

Testing using installer on Mac:

igb_logs.txt found in the .igb folder in the user's home directory - working
igb_logs.txt updates with new information as the user interacts with IGB - working
If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working
Starting IGB overwrites the igb_logs.txt file - working

Testing using installer on Windows:

igb_logs.txt found in the C:\Users\<user>\AppData\Roaming\IGB folder - working
igb_logs.txt updates with new information as the user interacts with IGB - working
If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working
Starting IGB overwrites the igb_logs.txt file - working

Testing using installer on Linux:

igb_logs.txt found in the .igb folder in the user's home directory - working
igb_logs.txt updates with new information as the user interacts with IGB - working
If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working
Starting IGB overwrites the igb_logs.txt file - working

Ready for pull request.

Show

Nowlan Freese added a comment - 11/Mar/24 2:57 PM - edited Testing using installer on Mac: igb_logs.txt found in the .igb folder in the user's home directory - working igb_logs.txt updates with new information as the user interacts with IGB - working If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working Starting IGB overwrites the igb_logs.txt file - working Testing using installer on Windows: igb_logs.txt found in the C:\Users\<user>\AppData\Roaming\IGB folder - working igb_logs.txt updates with new information as the user interacts with IGB - working If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working Starting IGB overwrites the igb_logs.txt file - working Testing using installer on Linux: igb_logs.txt found in the .igb folder in the user's home directory - working igb_logs.txt updates with new information as the user interacts with IGB - working If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working Starting IGB overwrites the igb_logs.txt file - working Ready for pull request.

Nowlan Freese made changes - 12/Mar/24 10:26 AM

Assignee

Kaushik Gopu [ kgopu ]

Nowlan Freese made changes - 12/Mar/24 10:26 AM

Status

First Level Review in Progress [ 10301 ]

Ready for Pull Request [ 10304 ]

Hide

Permalink

Kaushik Gopu added a comment - 13/Mar/24 10:29 AM

PR has been submitted.

Show

Kaushik Gopu added a comment - 13/Mar/24 10:29 AM PR has been submitted.

Kaushik Gopu made changes - 13/Mar/24 10:30 AM

Assignee

Kaushik Gopu [ kgopu ]

Ann Loraine [ aloraine ]

Kaushik Gopu made changes - 13/Mar/24 10:32 AM

Status

Ready for Pull Request [ 10304 ]

Pull Request Submitted [ 10101 ]

Hide

Permalink

Ann Loraine added a comment - 13/Mar/24 3:40 PM

PR is merged.

I have a doubt:

The file name is plural - "igb_logs.txt" instead of "igb_log.txt". Is it plural because there is more than one log?
If the log file only reports on one "run" of IGB, seems like it should be "igb_log.txt" instead.

Show

Ann Loraine added a comment - 13/Mar/24 3:40 PM PR is merged. I have a doubt: The file name is plural - "igb_logs.txt" instead of "igb_log.txt". Is it plural because there is more than one log? If the log file only reports on one "run" of IGB, seems like it should be "igb_log.txt" instead.

Ann Loraine made changes - 13/Mar/24 3:40 PM

Status

Pull Request Submitted [ 10101 ]

Reviewing Pull Request [ 10303 ]

Ann Loraine made changes - 13/Mar/24 3:40 PM

Status

Reviewing Pull Request [ 10303 ]

Merged Needs Testing [ 10002 ]

Hide

Permalink

Nowlan Freese added a comment - 13/Mar/24 3:42 PM

The file is within the .igb folder, so we could just call it log.txt

Show

Nowlan Freese added a comment - 13/Mar/24 3:42 PM The file is within the .igb folder, so we could just call it log.txt

Ann Loraine made changes - 13/Mar/24 4:05 PM

Assignee

Ann Loraine [ aloraine ]

Hide

Permalink

Nowlan Freese added a comment - 14/Mar/24 10:35 AM - edited

Kaushik Gopu - please rename the file "log.txt" and create a pull request to "main" branch.

Show

Nowlan Freese added a comment - 14/Mar/24 10:35 AM - edited Kaushik Gopu - please rename the file "log.txt" and create a pull request to "main" branch.

Nowlan Freese made changes - 14/Mar/24 10:35 AM

Status

Merged Needs Testing [ 10002 ]

Post-merge Testing In Progress [ 10003 ]

Nowlan Freese made changes - 14/Mar/24 10:35 AM

Status

Post-merge Testing In Progress [ 10003 ]

To-Do [ 10305 ]

Nowlan Freese made changes - 14/Mar/24 10:35 AM

Assignee

Kaushik Gopu [ kgopu ]

Hide

Permalink

Kaushik Gopu added a comment - 14/Mar/24 1:27 PM - edited

Changed file name from igb_logs.txt to log.txt
Squashed the commit into the previous commit.
Change is available in this branch.

Show

Kaushik Gopu added a comment - 14/Mar/24 1:27 PM - edited Changed file name from igb_logs.txt to log.txt Squashed the commit into the previous commit. Change is available in this branch .

Kaushik Gopu made changes - 14/Mar/24 1:27 PM

Status

To-Do [ 10305 ]

In Progress [ 3 ]

Kaushik Gopu made changes - 14/Mar/24 1:28 PM

Status

In Progress [ 3 ]

Needs 1st Level Review [ 10005 ]

Kaushik Gopu made changes - 14/Mar/24 1:28 PM

Assignee

Kaushik Gopu [ kgopu ]

Nowlan Freese [ nfreese ]

Nowlan Freese made changes - 14/Mar/24 1:53 PM

Status

Needs 1st Level Review [ 10005 ]

First Level Review in Progress [ 10301 ]

Nowlan Freese made changes - 14/Mar/24 1:53 PM

Status

First Level Review in Progress [ 10301 ]

To-Do [ 10305 ]

Nowlan Freese made changes - 14/Mar/24 1:53 PM

Assignee

Nowlan Freese [ nfreese ]

Kaushik Gopu [ kgopu ]

Hide

Permalink

Kaushik Gopu added a comment - 14/Mar/24 3:51 PM

PR has been submitted.

Show

Kaushik Gopu added a comment - 14/Mar/24 3:51 PM PR has been submitted.

Kaushik Gopu made changes - 14/Mar/24 3:51 PM

Assignee

Kaushik Gopu [ kgopu ]

Ann Loraine [ aloraine ]

Nowlan Freese made changes - 14/Mar/24 4:27 PM

Status

To-Do [ 10305 ]

Pull Request Submitted [ 10101 ]

Ann Loraine made changes - 15/Mar/24 10:01 AM

Status

Pull Request Submitted [ 10101 ]

Reviewing Pull Request [ 10303 ]

Hide

Permalink

Ann Loraine added a comment - 15/Mar/24 10:06 AM - edited

Pr is merged. Installers are built and ready for testing.

Show

Ann Loraine added a comment - 15/Mar/24 10:06 AM - edited Pr is merged. Installers are built and ready for testing.

Ann Loraine made changes - 15/Mar/24 10:07 AM

Status

Reviewing Pull Request [ 10303 ]

Merged Needs Testing [ 10002 ]

Ann Loraine made changes - 15/Mar/24 10:07 AM

Assignee

Ann Loraine [ aloraine ]

Nowlan Freese made changes - 15/Mar/24 11:25 AM

Status

Merged Needs Testing [ 10002 ]

Post-merge Testing In Progress [ 10003 ]

Hide

Permalink

Nowlan Freese added a comment - 15/Mar/24 11:28 AM

Testing using main installer on Mac:

igb_logs.txt found in the .igb folder in the user's home directory - working
igb_logs.txt updates with new information as the user interacts with IGB - working
If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working
Starting IGB overwrites the igb_logs.txt file - working

Closing ticket

Show

Nowlan Freese added a comment - 15/Mar/24 11:28 AM Testing using main installer on Mac: igb_logs.txt found in the .igb folder in the user's home directory - working igb_logs.txt updates with new information as the user interacts with IGB - working If IGB stops suddenly (force quit), the igb_logs.txt file is still present with the most recent log - working Starting IGB overwrites the igb_logs.txt file - working Closing ticket

Nowlan Freese made changes - 15/Mar/24 11:29 AM

Assignee

Kaushik Gopu [ kgopu ]

Nowlan Freese made changes - 15/Mar/24 11:29 AM

Resolution		Done [ 10000 ]
Status	Post-merge Testing In Progress [ 10003 ]	Closed [ 6 ]

People

Assignee:

Kaushik Gopu

Reporter:

Nowlan Freese

Votes:

0 Vote for this issue

Watchers:

3 Start watching this issue

Dates

Created:

23/Jan/24 9:40 AM

Updated:

15/Mar/24 11:29 AM

Resolved:

15/Mar/24 11:29 AM