Skip to main content
Mitratech Success Center

Different Logging Levels/Views and You: A Beginners Guide

This guide will give a brief summary of the most commonly used logging views and how/when to set the logging levels to DEBUG in order to gather information that is not readily available by the ERROR level logger. INFO, WARN, and FATAL are not logging levels that are generally used, so this guide will focus on ERROR and DEBUG levels.

NOTE: ALWAYS REMEMBER TO SET THE LOGGING LEVEL BACK TO ERROR AFTER GATHERING DEBUG LOGS


How to get to the logging page/gather logs:

1. Navigate to the "Admin" tab

2. Select "Logging" from the left menu

LoggingLocations2.PNG

3. Logs can be gathered from the "System Appenders" block at the bottom of this screen by clicking "View Log"

LoggingAppenders.PNG

 


Logging Views (Most commonly used/useful)

ROOT General System Logger
  Set to DEBUG if you do not know where the error you're receiving is coming from. This logger is the most likely to crash your system if left on DEBUG for too long
REQUEST Identify webservice calls sent to teamconnect
  DEBUG when you want to get a full breakdown of calls that are coming into Teamconnect as well as point of failure
RESPONSE Identify Webservice calls sent from teamconnect
  DEBUG when you want to get a full breakdown of the calls being sent out of Teamconnect as well as point of failure
SQL Identify the SQL that is being run by reports/searches/updates
  DEBUG will need to be used to gather SQL statements, as most SQL logging is turned off at the ERROR level. This is the second riskiest logger to leave on DEBUG so remember to set it back to error.
RULE Identify custom rule statements
  DEBUG will show specific debug statements written into the custom rules. ERROR will generally just tell you what rule is running. DEBUG helpful for identifying point of failure in the rule
XML Identify actions being taken when working with the XML worksheet.
  DEBUG if you are experiencing issues with the XML worksheet or custom rules that use XML in their logic

System Appenders (gathering logs)

Default Full Log file. Useful when looking for general failure. First place to check if you are lost
CSM Appender Only logs related to CSM sync. Use this when trying to diagnose issues with the CSM sync. Most CSM sync errors will show up in default logs, but these make it easier to find.
XML Appender Only logs related to XML. XML logs often do not show up in default logs, so if you're having trouble finding them there, look here.

 


General Logging Etiquette

  • If possible reproduce in Non-Production environment
    • Clear logs and set appropriate logging levels
    • Reproduce error
    • Capture logs (input into a .txt file)
    • Send Logs with any relevant screenshots and a brief description of the error to teamconnectsupport@mitratech.com
  • If you can only reproduce in PROD
    • If possible clear the logs and have the user reproduce the error
    • Provide logs to support (teamconnectsupport@mitratech.com) and indicate the username of the user experiencing the error and a rough time stamp of when the error occurred.