Tracing in TIBCO Scribe® Insight
Article ID: KB0078986
Updated On:
| Products | Versions |
|---|---|
| TIBCO Scribe Insight | All |
Description
When encountering an issue in TIBCO Scribe® Insight, to get to the bottom of what is occurring the fastest, tracing is a powerful tool. Tracing shows specific information regarding the operations that are being performed at the time of the integration and also includes the data being passed in each step. In Insight there are two locations where you can go to enable tracing, the Workbench and the Console.
The Workbench only traces operations performed within the Workbench application. Using Tracing here is great for issues that are not specific to an integration in the Console or can be narrowed down to a single record, file, or consistent behavior (happens every run) that is easily reproduced in the Workbench. When using tracing in the Workbench, best practice is opening a blank Workbench and enable tracing first and then opening the DTS file. This ensures that any and all activity regarding the DTS (including the initial connections to the Source and Target applications) are captured.
Workbench Tracing
To enable tracing in the Workbench you need to launch the Workbench and select View > Options.
In the window that popups after selecting "options", check Tracing Enabled and click Apply. This is also where you choose the location to output trace files. Best practice is to keep this in the default location of C:\Users\Public\Documents\Scribe\Tracing just to make it an easy and accessible location for individuals who are investigating integration issues. Selecting the Open Trace Folder option brings you to the trace folder and if you clicked Apply you see a TWorkbench.log file.
After enabling tracing, there is an icon that looks like an open book in the bottom right of the Workbench. This symbol shows that the Workbench is actively tracing.
Console Tracing
To enable tracing in the Console, launch the Console and go to Administration>Site Settings>Tracing. Select Enable Tracing (if tracing is already enabled, the button says Disable Tracing). However, if you have never used the Workbench tracing, the trace folder location is missing. YEstablish this location in the Workbench following the steps in Workbench Tracing.
Once you enable (or disable) tracing, go to Windows services and stop the five Scribe services one by one starting with the bottom (Scribe MonitorServer if the list is sorted alphabetically) and ending with the Scribe AdminServer. After that start them back up starting with AdminServer and working your way back down to MonitorServer.
Once you have done this at the location specified in the Console you will find a file for each service and message processor (as they start).
Notes
When you are done with any tracing make sure to turn it off. If tracing remains on it can cause an issue with space on the hard drive as these files grow very large because they record any and all actions performed by the application.
Make sure to always do tracing with fresh trace files that are only collecting data while troubleshooting the issue, either by deleting, moving, or renaming old trace files. This helps eliminate any chance of incorrect information being in the logs when trying to resolve an issue with your integrations.
If the issue is easily reproduced and you are opening a support case, capture the issue in a trace file and attach to the case. Tracing of an issue can provide extremely valuable information that will help support resolve your issue faster.
When looking at the trace file, try doing a search for the error you are seeing in the software, this brings you to the error and allows you to work your way backwards to find the what is occurring leading up to the error.
Trace files can also reveal errors that are happening on a lower level and don't make it to an application level.
The Workbench only traces operations performed within the Workbench application. Using Tracing here is great for issues that are not specific to an integration in the Console or can be narrowed down to a single record, file, or consistent behavior (happens every run) that is easily reproduced in the Workbench. When using tracing in the Workbench, best practice is opening a blank Workbench and enable tracing first and then opening the DTS file. This ensures that any and all activity regarding the DTS (including the initial connections to the Source and Target applications) are captured.
Workbench Tracing
To enable tracing in the Workbench you need to launch the Workbench and select View > Options.
In the window that popups after selecting "options", check Tracing Enabled and click Apply. This is also where you choose the location to output trace files. Best practice is to keep this in the default location of C:\Users\Public\Documents\Scribe\Tracing just to make it an easy and accessible location for individuals who are investigating integration issues. Selecting the Open Trace Folder option brings you to the trace folder and if you clicked Apply you see a TWorkbench.log file.
After enabling tracing, there is an icon that looks like an open book in the bottom right of the Workbench. This symbol shows that the Workbench is actively tracing.
Console Tracing
To enable tracing in the Console, launch the Console and go to Administration>Site Settings>Tracing. Select Enable Tracing (if tracing is already enabled, the button says Disable Tracing). However, if you have never used the Workbench tracing, the trace folder location is missing. YEstablish this location in the Workbench following the steps in Workbench Tracing.
Once you enable (or disable) tracing, go to Windows services and stop the five Scribe services one by one starting with the bottom (Scribe MonitorServer if the list is sorted alphabetically) and ending with the Scribe AdminServer. After that start them back up starting with AdminServer and working your way back down to MonitorServer.
Once you have done this at the location specified in the Console you will find a file for each service and message processor (as they start).
Notes
When you are done with any tracing make sure to turn it off. If tracing remains on it can cause an issue with space on the hard drive as these files grow very large because they record any and all actions performed by the application.
Make sure to always do tracing with fresh trace files that are only collecting data while troubleshooting the issue, either by deleting, moving, or renaming old trace files. This helps eliminate any chance of incorrect information being in the logs when trying to resolve an issue with your integrations.
If the issue is easily reproduced and you are opening a support case, capture the issue in a trace file and attach to the case. Tracing of an issue can provide extremely valuable information that will help support resolve your issue faster.
When looking at the trace file, try doing a search for the error you are seeing in the software, this brings you to the error and allows you to work your way backwards to find the what is occurring leading up to the error.
Trace files can also reveal errors that are happening on a lower level and don't make it to an application level.
Issue/Introduction
How to enable tracing in TIBCO Scribe® Insight
Feedback
Yes
No
Powered by
