Setting Debug Mode In TIBCO Scribe® Online For The On-Premise Agent

Setting Debug Mode In TIBCO Scribe® Online For The On-Premise Agent

book

Article ID: KB0078546

calendar_today

Updated On:

Products Versions
TIBCO Cloud Integration - Connect ( Scribe ) -

Description

Debug mode is used to increase the amount of information logged by the On-Premise Agent while it is running.  These log files provide TIBCO Scribe® Support with more insight into any issues you might be having.  Debug mode can be enabled either through the TIBCO Scribe® Online User Interface or manually by editing a configuration file.  Debug mode can be kept running by adding some lines to a configuration file.  TIBCO Scribe® recommends enabling Debug mode by using the TIBCO Scribe® Online User Interface, but both methods are documented here.
 


Enable Debug Via The Scribe Online User Interface
 

  1. Log into TIBCO Scribe® Online.
  2. From the menu select More > Agents.
  3. Select an Agent name to open the Edit Agent dialog.
  4. Under Agent logging click the Debug check box to enable it.
  5. Click OK to save your settings.
Note:  If you have been instructed by TIBCO Scribe® Support to enable Trace, you must also enable Debug.  Trace does not run unless Debug is enabled.
  1. Try to reproduce the original problem.
  2. Navigate to the ..\Program Files (x86)\Scribe Software\Scribe Online Agent\logs folder.
  3. Send any files in the folder to TIBCO Scribe® Support.
  4. Return to the Scribe Online Edit Agent Settings dialog and turn off Debug and Trace.
 
  kA3320000004RnnCAE_en_US_1_0


Enable Debug By Editing The Configuration File
 

  1. Use the Microsoft Windows Services dialog to locate and stop the Scribe Online Agent Service.
  2. Use Windows Explorer to find the folder where your TIBCO Scribe® Online Agent is installed.
    Make sure to select the proper folder if more than one Agent is installed.
..\Program Files (x86)\Scribe Software\Scribe Online Agent
  1. Find the Scribe.Core.ProcessorService.exe.config file and make a backup copy.
Note: If your folder settings are configured to hide known extensions, the .config may be missing when viewing the file from Windows Explorer.
  1. Use NotePad++ or another text editor to open and edit the Scribe.Core.ProcessorService.exe.config file.
Note:  Make sure to run the text editor as Administrator or the changes to the file may not be saved.
  1. Change the two values highlighted in the picture below from false to true. These settings are in the “appSettings” section.
  2. Save the changes to the Scribe.Core.ProcessorService.exe.config file.
  3. Delete the all of the *.log files in the Logs folder.
  4. Use the Microsoft Windows Services dialog to locate and restart the Scribe Online Agent Service.
  5. Try to reproduce the problem.
  6. Navigate to the ..\Program Files (x86)\Scribe Software\Scribe Online Agent\logs folder.
  7. Send any files in the folder to Scribe Support.
  8. Turn off debugging options in the .config file and restart the Scribe Online Agent Service
 
kA3320000004RnnCAE_en_US_1_1
 


Expanding The Size Of The Rolling Log And/Or The Number Of Log Files
 

The Configuration file mentioned in the instructions above also controls the size of the Rolling Log and the number of Log Files that are retained using the parameters in the Rolling Flat File Trace Listener section highlighted in the following image:


kA3320000004RnnCAE_en_US_1_2



For more information on Rolling Logs and setting parameters, see the following MSDN articles:
See the following in TIBCO Scribe® Online Help:

Issue/Introduction

Debug mode is used to increase the amount of information logged by the On-Premise Agent while it is running. These log files provide Scribe Support with more insight into any issues you might be having.