Improve logging output of function

[Jaclynpqc]

This pull request enhances the logging output in the main.py file by strategically placing logger.debug statements in various functions. The improved logging provides detailed information about the execution flow, enabling easier debugging and troubleshooting.

I added logging statements relating to debug info, debug destination, file path directory, current version using:
For example,

Display verbose output? False
Debug level? DEBUG
Debug destination? SYSLOG
Current Chasten version 0.2.0
Using XPath version 2.0

I also add more logging statements at key points of the operation that likely going to cause error.
I attached a screenshot below, in which you could see two server CONSOLE and SYSLOG run at the same time for chasten analyze. While CONSOLE returns the checked patterns, SYSLOG returns some logging statement and info that might come in handy when troubleshooting and debugging the code:

[tuduun]

@Jaclynpqc Can you please provide the final version of the output and what it looks like? Although I can see the changes in the Files Changed tab, it may be easier for most people to see what it looks like. It may be helpful to display the before and after images of the improved logging system.

[gkapfham]

Hello @Jaclynpqc, can you please give examples of the output that this logging output would produce? Can you also confirm that you have tested it and shown that it works for all three of the major operating systems that we support? Also, can you please confirm that it works for both console logging and the syslog server?

[AlishChhetri]

This feature works on a linux device.

[Finley8]

This feature works on a Windows device!

[boulais01]

@Jaclynpqc Would you mind posting examples here of the elements @gkapfham requested, so we can close that request change?

[Jaclynpqc]

@gkapfham @boulais01 I have tested and confirmed that my implementation works on all three major OS systems, and on both CONSOLE and SYSLOG. This pull request enhances the logging output in the main.py file by strategically placing logging statements in various functions. The improved logging provides detailed information about the execution flow, enabling easier debugging and troubleshooting.

I added logging statements relating to debug info, debug destination, file path directory, and current version. For example:

Debug level? DEBUG
Debug destination? SYSLOG
Current Chasten version 0.2.0
Using XPath version 2.0

I also added more logging statements at key points of the operation that likely going to cause errors.

[gkapfham]

Hello @Jaclynpqc, thanks for this PR, it is helpful and now close to being merged. The main concern that I see right now is that the PR also includes an analysis.md file. This file was automatically created by the chasten program because it was running a feature that @Poiuy7312 created. Since this is a derived/generated file we want to make sure that we do not include it inside of our repository. Can you please remove this file and then request another review? Once you have made this change, I think that it should be ready for us to merge to the main trunk! Thanks!

[Jaclynpqc]

I have made additional changes to this feature. This PR is now ready to merge

[AlishChhetri]

Looks great! I have run the tool on my computer, Linux OS, and it does execute the desired result.

[laurennevill]

Nice work!

[laurennevill]

Once the changes are resolved, I can merge this

[laurennevill]

Once the changes are resolved, I can merge this

Oops, this also needs one more Professor/TL review

[tuduun]

Good job on deleting the md file and displaying the output as @gkapfham requested!

Changes made