System Logging In Timesheet 5.5

 Help Contents
Timesheet provides several logging methods that allow you to get a better view of what's happening within your organization's installation at any given time. This section of the documentation covers the three logging formats, from how to set them up to how to use and understand them.

Logging Preferences

The logging options for Timesheet are controlled via the Logging Preferences Screen, which is accessed via the Logging Preferences located in the System Settings section of the Main Admin Screen.

This screen allows the Timesheet Administrator to enable and disable the three logging options - Extended Tracebacks, Auditing and Diagnostic Logging. Additionally, the Diagnostic Log file, also referred to as the Timesheet debug log, can be erased from this screen.

Of the four buttons on this screen, the three that directly control the status of the logging options are dynamic; that is, the text of the buttons changes to reflect the status of their individual logging options. To enable or disable any particular logging option, simply click the button for that option. Timesheet will refresh the Logging Preferences Screen and display a green text message confirming the change.

Each of the logging options are described in detail below.

To delete the contents of the Diagnostic Log file, click the Button. Timesheet will refresh the Logging Preferences Screen and display a green text message confirming the deletion of this log file.

Extended Tracebacks

Timesheet uses Extended Tracebacks to provide precise detail regarding an error. If an error occurs when Extended Tracebacks are enabled, the error message will include a complete list of the individual pieces of the program that were involved in the generation of the error. If an error occurs when Extended Tracebacks are not enabled, the error message provided by Timesheet will not contain as much detail.

The output of an Extended Traceback can be invaluable in determining the cause of an error. In the unlikely event that you are receiving an error when using Timesheet, please provide the information from an Extended Traceback of that error to the Journyx Support Team. This data will facilitate a rapid response.

Extended Tracebacks may be turned on and left enabled in the background without reducing the performance of your organization's Timesheet installation.

Auditing

When Auditing is enabled, Timesheet will record every click and every action performed by every user who is logged into Timesheet at any time. This information can provide important insight into who is using Timesheet and what they are using it for. Certain organizations may find it useful to have this kind of finely focused data regarding their systems; however, Auditing is a demanding process that also creates a very large log file.

In general, Auditing should only be used for a short time to capture specific information. Because Auditing constantly records every action taken by every user, leaving it enabled can have a negative impact on the performance of your organization's's Timesheet installation.

The current size of the Audit Log File is displayed next to the status of this option on the Logging Preferences Screen for your reference.

The data recorded by Auditing can be viewed in the Audit Log. The process for viewing this information is covered below.

Diagnostic Logging

Diagnostic Logging is used by Timesheet to record information about how the application itself is running. This data is then stored in the Diagnostic Log file, debug.log, which can be sent to the Journyx Support Team if you encounter an error with Timesheet.

This process, like Auditing logs everything about the system, though unlike Auditing the focus is on what's happening with the program logic rather than who is doing what in the system. As a consequence, when Diagnostic Logging is enabled, Timesheet may suffer a reduction in performance. Additionally, the Diagnostic Log file can become quite large if this option is left running for longer than a short period of time.

Journyx recommends enabling this option if you encounter an error, capturing that error in the Diagnostic Log file, and then turn Diagnostic Logging back off. You can then send the Diagnostic Log file to Journyx to provide out Support Team with valuable information regarding the error.

The current size of the Diagnostic Log File is displayed next to the status of this option on the Logging Preferences Screen for your reference.

Viewing The Audit Log

The contents of the Audit Log file, audit.log, can be viewed directly through Timesheet via the Auditing Log Screen which is accessed via the View Audit Log, which is located on the Main Admin Screen in the System Settings section.

When Auditing has been enabled, the Audit Log captures the following information regarding every action performed by every user in your organization's installation of Timesheet: This information provides a clear insight into which users have been performing which actions within Timesheet during the time that Auditing was enabled.

The Audit Log can become quite large if auditing is left running for any significant period of time. To clear out the contents of the Audit Log file, click the Button on this page. Timesheet will refresh the Auditing Log Screen and display a red text message confirming the deletion of the Audit Log. Please Note: Deleting the Audit Log cannot be undone; therefore, the log should only be deleted when you are certain that the contents are no longer necessary.

If you view the Auditing Log Screen when the Audit Log file is empty, either because Auditing has never been turned on or because the contents of the Audit Log have been deleted, Timesheet will display a red text message informing you that the Audit Log file is empty.