Rate and give feedback:  Feedback Received. Thank You!

Rate and give feedback: 

X

This document helped resolve my issue

Yes No

Additional Comments

800 characters remaining

May we contact you if necessary?

Name:  

E-mail: 

Enter a valid Email ID

Need product assistance? Contact Juniper Support

Submit

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.

English  

English

Tracing Commit Script Processing

Commit script tracing operations track all commit script operations and record them in a log file. The logged error descriptions provide detailed information to help you solve problems faster.

The default operation of commit script tracing is to log important events in a file called cscript.log located in the /var/log directory on the device. When the file cscript.log reaches 128 kilobytes (KB), it is renamed with a number 0 through 9 (in ascending order) appended to the end of the file and then compressed. For example, the log file is saved as cscript.log.0.gz, then cscript.log.1.gz until there are 10 trace files. Then the oldest trace file (cscript.log.9.gz) is overwritten. (For more information about how log files are created, see the Junos OS System Log Messages Reference.)

This section discusses the following topics:

Minimum Configuration for Tracing for Commit Script Operations

If no commit script trace options are configured, the simplest way to view the trace output of a commit script is to configure the output trace flag and issue the show log cscript.log | last command. To do this, perform the following steps:

1. If you have not done so already, enable a commit script by including the file statement at the [edit system scripts commit] hierarchy level:

   [edit system scripts commit]user@host# set file filename

2. Enable trace options by including the traceoptions flag output statement at the [edit system scripts commit] hierarchy level:

   [edit system scripts commit]user@host# set traceoptions flag output

3. Issue the commit command:

   [edit]user@host# commit

4. Display the resulting trace messages recorded in the file /var/log/cscript.log. At the end of the log is the output generated by the commit script you enabled in Step 1. To display the end of the log, issue the show log cscript.log | last operational mode command:

   [edit]user@host# run show log cscript.log | last

Table 1 summarizes useful filtering commands that display selected portions of the cscript.log file.

Example: Minimum Configuration for Enabling Traceoptions for Commit Scripts

Display the trace output for the commit script file source-route.xsl:

Jun 20 10:21:24 summary: changes 0, transients 0 (allowed), syslog 0
Jun 20 10:24:15 commit script processing begins
Jun 20 10:24:15 reading commit script configuration
Jun 20 10:24:15 testing commit script configuration
Jun 20 10:24:15 opening commit script '/var/db/scripts/commit/source-route.xsl'
Jun 20 10:24:15 script file '/var/db/scripts/commit/source-route.xsl': size=699; md5 = d947972b429d17ce97fe987d94add6fd
Jun 20 10:24:15 reading commit script 'source-route.xsl'
Jun 20 10:24:15 running commit script 'source-route.xsl'
Jun 20 10:24:15 processing commit script 'source-route.xsl'
Jun 20 10:24:15 results of 'source-route.xsl'
Jun 20 10:24:15 begin dump
<commit-script-output xmlns:junos="http://xml.juniper.net/junos/*/junos" xmlns:xnm="http://xml.juniper.net/xnm/1.1/xnm" xmlns:jcs="http://xml.juniper.net/junos/commit-scripts/1.0">
    <xnm:warning>
        <edit-path>[edit chassis]</edit-path>
        <message>IP source-route processing is not enabled.</message>
    </xnm:warning>
</commit-script-output>Jun 20 10:24:15 end dump
Jun 20 10:24:15 no errors from source-route.xsl
Jun 20 10:24:15 saving commit script changes
Jun 20 10:24:15 summary: changes 0, transients 0 (allowed), syslog 0

Configuring Tracing of Commit Scripts

You cannot change the directory (/var/log) to which trace files are written. However, you can customize other trace file settings by including the following statements at the [edit system scripts commit traceoptions] hierarchy level:

These statements are described in the following sections:

• Configuring the Commit Script Log Filename
• Configuring the Number and Size of Commit Script Log Files
• Configuring Access to Commit Script Log Files
• Configuring the Commit Script Trace Operations

Configuring the Commit Script Log Filename

Configuring the Number and Size of Commit Script Log Files

By default, when the trace file reaches 128 KB in size, it is renamed and compressed to filename.0.gz, then filename.1.gz, and so on, until there are 10 trace files. Then the oldest trace file (filename.9.gz) is overwritten.

For example, set the maximum file size to 640 KB and the maximum number of files to 20. When the file that receives the output of the tracing operation (filename) reaches 640 KB, it is renamed and compressed to filename.0.gz, and a new file called filename is created. When filename reaches 640 KB, filename.0.gz is renamed filename.1.gz and filename is renamed and compressed to filename.0.gz. This process repeats until there are 20 trace files. Then the oldest file (filename.19.gz) is overwritten.

The number of files can range from 2 through 1000 files. The file size can range from 10 KB through 1 gigabyte (GB).

Note: If you set either a maximum file size or a maximum number of trace files, you also must specify the other parameter and a filename.

Configuring Access to Commit Script Log Files

The no-world-readable statement restricts commit script log access to the owner. The world-readable statement enables unrestricted access to the commit script log file.

Configuring the Commit Script Trace Operations

Table 2 describes the meaning of the commit script tracing flags.