Run a QuerySurge Agent in Debug Mode

Agent Debug Mode

QuerySurge Agents have debug settings designed to help indicate the nature of issues that might arise with Connections and how they behave in your environment. The debug settings control the information that is written to the Agent logs. There are three debug mode levels:

• Debug Level 0: The default level; the standard level of information is written to the logs
• Debug Level 1: Query metadata is written to the logs during execution
• Debug Level 2: Query metadata and data are written to the logs during execution

Setting up and Managing Debug Mode

In order to put an Agent in Debug mode, follow these instructions:

1. Stop your Agent
   
   
2. Locate the Agent config directory, \\<QuerySurge Install Dir>\QuerySurge\agent\config\.
   On Windows, the default directory is: C:\Program Files\QuerySurge\agent\config\
   On Linux, the default directory is: /opt/QuerySurge/agent/config/


3. In the Agent config directory, you'll find the config file: agentconfig.xml. Make a copy of this file (agentconfig.xml.bak).
   
   
4. Carefully edit agentconfig.xml in a text editor. You may need elevated rights (i.e. admin rights) in order to edit and save this file.
   
   
5. In agentconfig.xml, immediately under the root <config> tag, add a <debug> tag. The value of the <debug> tag is the debug level you want to execute under:
   <config>
     <debug>1</debug>
     ....
</config>
   
   
6. Save the changes to agentconfig.xml
   
   
7. Start your Agent.
   
   
8. Re-execute your QueryPair. Note that the log files may grow substantially depending on the debug level you are using, and the amount of data returned by your QueryPair.
   
   
9. Agent log files are at: 
   Windows: <QuerySurge Install Dir>\QuerySurge\agent\logs\
   Linux: /<QuerySurge Install Dir>/QuerySurge/agent/qsagent-err.log
   On Windows, the default log directory is: C:\Program Files\QuerySurge\agent\logs\
On Linux, the default log file is: /opt/QuerySurge/agent/qsagent-err.log
   
   
10. Recover the log. Usually, QuerySurge support will have requested the log.
    

    Important Note: If you have used Debug Level 1 or 2, the log may contain data that may be deemed sensitive. This is especially true for Debug Level 2. Please review the log before sending it to Support, and determine that the log contents may be shared externally.

11. Stop your Agent.
    
    
12. Carefully revert agentconfig.xml to its default value (either remove the <debug> tag entirely or set the Debug Level to 0 (<debug>0</debug>). If you do not re-set this value, your logs may grow quite large, and eventually the logs will fill the disk. High levels of disk usage may happen rapidly. In addition, the information in the logs may pose security concerns.