Module: Log Viewer

 Created Date: 10/29/2018 |  User Level: Regular User |  Views: 3,104

Description

The Log Viewer module is the only module that allows you to view information but never delete or edit information. This module is completely for read-only access to what is happening within the system. There are four logging levels within the system. The default level is logging only the minimal amount of information where other levels increase the amount of logging that happens within the system.

Requirements

  • You will need to have access to the log file module

Notes

  • There is no deleting or editing allowed within the system
  • Logging Levels
    • Level 0: Logging level 0 adds everything from levels 1 through 3 and logs everything except for passwords and confidential information that might compromise system security. This level logs items as they happen so that developers are able to more quickly trace every action the system was doing.
    • Level 1: Logging level 1 adds from the previous levels (Level 2 and Level 3) and adds internal developer debugging errors within the system.
    • Level 2: Logging level 2 adds from the previous level (Level 3) and adds in saving errors into the logs.
    • Level 3: This is the default logging level. This logs all email correspondence and major errors in the system.
  • Logs are deleted after a predefined number of days. The exception to removal of old information is that anything that is marked as being emailed out of the system is never deleted and will always be in the system.

Sample Screenshot

Log Viewer

Viewing Log Viewer

  • Click on Log Viewer
  • Click on the magnifying glass () to view a specific log entry.
  • The log file screen is broken into the following fields:
    • Default Information
      • Category Name: This is the unique category that was assigned by the system stating what module/section of the application the information is coming from.
      • IP Address: If the entry related to a user the entry will show the IP address the user is from.
      • Created Date: This is the date/time the log entry was created. This date/time may be different for individual users as it is automatically adjusted from UTC time to the users local time.
      • Payload: This is the error/information from the system.
        • Note 1: When viewing the payload there is a copy icon. You can copy the information that you have selected from the log into clipboard.
        • Note 2: In relation to emails the entire email is placed here which includes who the email was sent TO, CC, and BCC. The response from the mail server is also stored at the bottom of the message.
    • XML Payload Information
      • In some circumstances the system will save XML information. This information is often from linked web services and external applications the website is communicating with. Whenever the XML information is available to be shown it will be listed here.

Latest Brilliance CRM KB Articles