Script Tracer and debugging scripts
Summarize
Summary of Script Tracer and Debugging Scripts
The Script Tracer is a powerful tool designed to help administrators efficiently debug scripts and business rules within ServiceNow. It allows users to pinpoint specific lines of scripts that have changed during execution, streamlining the debugging process and enhancing productivity.
Show less
Key Features
- Admin Role Required: Access to the Script Tracer is restricted to users with an admin role.
- Execution Filtering: Filter searches by file type and specific table to refine your debugging efforts.
- Change Tracking: The Tracer lists changes made to scripts in real-time, making it easy to identify issues.
- Information Tabs: Utilize the State tab to view script differences, and the Transaction tab for tracing records.
- Error Display: Any errors encountered are shown at the top of the State tab, complete with line numbers and messages.
- Limit Configuration: Users can set a maximum line limit for tracing, with a default of 1,000 lines, which can be adjusted via the
glide.debug.trace.tracelinelimitproperty.
Key Outcomes
By effectively utilizing the Script Tracer, ServiceNow customers can expect a more efficient debugging process, allowing for quicker identification and resolution of script issues. This leads to improved application performance and reduced downtime.
The Script Tracer can help you filter your debugging search to quickly narrow down script problems. You can identify lines of scripts in the Glide record that have undergone change during execution. Finding those specific lines of scripts rather than doing a wide search helps save time and improves productivity.
Overview of Script Tracer
Once you enable Script Tracer and execute a UI transaction, the Tracer searches through all the scripts being executed. The following filters are available:
- File type: Search for a specific file type
- Table: Look in the specific table for the script being executed
The Script Tracer searches for changes in the script during execution and presents them in a
list for you to examine. When you click Start Tracer, the Tracer begins
searching for changes in the Glide record. You can click the Debug Script
button at any time to see the script itself.
Use the tabs to see specific information from the Tracer.
- By default, the Show only changed values check box is enabled, so you can avoid fields that have not changed.
- To view all the fields (changed or not), you can clear that check box.
If there are any errors, they display at the top of
the State tab, with their line numbers and error message displayed in order of
occurrence.
- Script: Displays the line of changed scripts that the Glide record has undergone during execution. You can view the entire line of script by clicking the Show Script button.
- Transaction: Shows all transaction records of the trace
- Debug Script: Opens the script in Debugger to debug the script
- View File: Opens the script in the ServiceNow platform for editing
- Clear trace: Clears the trace when you are finished.
Limiting the tracer
You may want to set a limit for your trace so that you don't generate too many returns. By default there will be up to 1,000 lines of script traced. Once this number is reached you must clear the trace and start tracing again. If you want to change the maximum number of lines for tracing you can configure your limit using the property glide.debug.trace.trace_line_limit.
Since each trace you run is new, make sure you're finished reading the results of one trace before clearing it and beginning another one.
To learn more, see Debugging scripts.