Configuring Output from the Siebel ARM Query Tool

This topic is part of Analyzing Siebel ARM Files Using the Siebel ARM Query Tool.

This topic discusses the output options that are available to you when you use the Siebel ARM Query Tool. The following table describes the flags that you can use to configure output.

The Siebel ARM Query Tool can simultaneously write output to files in the TXT, XML and CSV formats. The following example shows using the Siebel ARM Query Tool to write different types of information to different files.

> sarmquery –input d:\sarmdata –select subarea=infra_entry –select resp=1000 
–output header=hdr.csv –output sarm=sarm.csv -aggregate area –output agg=agg.xml 

The preceding command writes:

• Information about the header metadata from the Siebel ARM files to the file hdr.csv.

• Siebel ARM data to the file sarm.csv.

• Aggregate information about the area to the file agg.xml.

You can also specify a maximum number of lines to write to a file. When the file contains the maximum number of lines specified, the Siebel ARM Query Tool creates a new file with the same filename plus N, where N equals a number. The following example illustrates the use of this option:

> sarmquery –output sarm=sarmdata.csv#20000 

This command writes Siebel ARM data in comma-separated values (CSV) format to the file named sarmdata.csv. The optional value #20000 writes a maximum of 20,000 lines to sarmdata.csv. Once sarmdata.csv contains 20,000 lines, the Siebel ARM Query Tool writes to a new file with the name sarmdata_0002.csv, and so on, until all of the applicable data is output.

All flags in the following table must be preceded by the option -output.

Flag	Description
fdr=filename	Converts all FDR files (specified using –input) to CSV format and write them to the specified file. Note: For more information about FDR (flight data recorder) files, see Siebel System Monitoring and Diagnostics Guide.
fdrhdr=filename	Converts all of the FDR headers to CSV and write them to the specified file.
error=filename	By default, the Siebel ARM Query Tool writes output to the file stderr.txt. This command redirects error messages to the specified file.
debug=filename	By default, Siebel ARM query does not write debug messages. This command enables the Siebel ARM Query Tool to write debug messages to the file specified file.
dbglines=filename	This command enables the Siebel ARM Query Tool to write more debug information.
verbose=filename	By default, the Siebel ARM Query Tool writes to the file stderr.txt. This command redirects verbose output to the specified file.
map=filename	Creates a file which lists all areas and subareas for Siebel ARM.
header=filename appheader=filename cliheader=filename	The available flags are: header Writes all header information to the specified file. appheader Writes header information from Siebel ARM files generated by the Siebel Server. cliheader Writes header information from the Siebel ARM files generated by clients. The following example writes information about all headers to all.csv and then writes information for each specific part to a different file: > sarmquery –input dir –output header=all.csv –output appheader=app.csv –output cliheader=cli.csv
sarm=filename appsarm=filename clisarm=filename	The available flags are: sarm Writes all Siebel ARM data to the specified file. appsarm Writes all Siebel ARM data generated by the Siebel Server to the specified file. clisarm Writes all Siebel ARM data generated by clients. The following example writes Siebel ARM data generated by the Siebel Server: > sarmquery –output appsarm=app.csv
agg=filename iagg=filename sagg=filename	The available flags are: agg Writes the aggregation report to the specified file. sagg Writes a subset of the aggregation report to the specified file. This flag specifies exclusive metrics. iagg Writes a subset of the aggregation report to the specified file. This flag specifies inclusive metrics. To use the options, you must have aggregated Siebel ARM data by using the flag -aggregate.
avginclresp=filename pctcount=filename pctinclresp=filename pctselftime=filename	The available flags are: avginclresp Writes the average response time to the specified file. pctcount Writes the percentage of server requests that complete within the specified time to the specified file. The following example writes the percentages of server requests that complete within 100 milliseconds, between 100 milliseconds to 500 milliseconds, and so on: > sarmquery –histogram resp=100,500,1000,2000,5000 – out pctcount=stdout.txt pctselftime Writes the percentage of time spent in internal parts of the Siebel Server. This is also known as SLA fingerprint.