traceoptions (Event Scripts)

Syntax

Hierarchy Level

Release Information

Statement introduced in Junos OS Release 7.6.

Statement introduced in Junos OS Release 9.0 for EX Series switches.

Statement introduced in Junos OS Release 13.2X51-D10 for QFX Series switches.

Description

Define tracing operations for event scripts.

Default

If you do not include this statement, the default operation during script execution is to log important events in the default trace file /var/log/escript.log, because the traceoptions events flag is turned on by default, regardless of the configuration settings. When the file reaches 128 kilobytes (KB), it is renamed and compressed.

Options

file filename—Name of the file to receive the output of the tracing operation. All files are placed in the directory /var/log. By default, event script process tracing output is placed in the file escript.log. If you include the file statement, you must specify a filename. To retain the default, you can specify escript.log as the filename.

Default: /var/log/escript.log

files number—(Optional) Maximum number of trace files. When a trace file named trace-file reaches its maximum size, it is renamed and compressed to trace-file.0.gz. When trace-file again reaches its maximum size, trace-file.0.gz is renamed trace-file.1.gz and trace-file is renamed and compressed to trace-file.0.gz. This renaming scheme continues until the maximum number of trace files is reached. Then the oldest trace file is overwritten.

If you specify a maximum number of files, you also must specify a maximum file size with the size option and a filename.

Range: 2 through 1000

Default: 10 files

flag flag—Tracing operation to perform. The events flag is turned on by default, regardless of the configuration settings. You can include the following flags. To specify more than one tracing operation, include multiple flag statements.

all—Log all operations
events—Log important events, including errors, warnings, progress messages, and script processing events
input—Log event script input data
offline—Generate data for offline development
output—Log event script output data
rpc—Log event script RPCs
xslt—Log the XSLT library

Default: events

no-world-readable—Restrict file access to owner. This is the default.

size size—(Optional) Maximum size of each trace file, in kilobytes (KB), megabytes (MB), or gigabytes (GB). When a trace file named trace-file reaches this size, it is renamed and compressed to trace-file.0.gz. When trace-file again reaches its maximum size, trace-file.0.gz is renamed trace-file.1.gz and trace-file is renamed and compressed to trace-file.0.gz. This renaming scheme continues until the maximum number of trace files is reached. Then the oldest trace file is overwritten.

If you specify a maximum file size, you also must specify a maximum number of trace files with the files option and a filename.

Syntax: size to specify bytes, sizek to specify KB, sizem to specify MB, or sizeg to specify GB

Range: 10 KB through 1 GB

Default: 128 KB

world-readable—Enable unrestricted file access.

Required Privilege Level

maintenance—To view this statement in the configuration.

maintenance-control—To add this statement to the configuration.