Go to main content
Oracle Developer Studio 12.5 Man Pages

Exit Print View

Updated: June 2017
 
 

er_html(1)

Name

er_html - generate an HTML file from an experiment for browsing the data

Synopsis

 er_html [-AO] [-c path] [-cc compiler_commentary_class] [-ct] [-h]
      [-im metric_list] [-l limit] [-n column_names] [-o|-O directory]
      [-q] [-tp percent] [-v] [-V] experiment-list

Description

The er_html command can process one or more experiments or experiment groups to generate a directory containing an HTML file, index.html, which can be used to browse the data.

The er_html command is particularly useful in situations where you want to remotely analyze the performance of an application, work with other team members who are located at other sites, or archive the performance of the application before some modifications are made.

Options

If invoked with no arguments, print a usage message.

Certain options can be set in a $HOME/.er_html.rc file (see at the end of this section).

–AO

Suppress automatic selection of metrics. By default, er_html attempts to pick the appropriate metrics to display from the experiment(s) given on the command line. This option restricts the metrics to just user, system, and wall time.

–c path

er_html uses the er_print command from the version of Oracle Developer Studio from which it is invoked. The -c flag can be used to specify a different er_print from a location other than the default one.

–cc compiler_commentary_class

The –cc flag can be used to choose a different compiler commentary class from the default one (class basic) produced via the –g flag of the Oracle Developer Studio cc compiler and interpreted by the er_print command. For example, –cc none will switch off compiler commentary. For all compiler commentary classes see the Oracle Developer Studio 12.5: Performance Analyzer for the er_print scc command.

–ct

Provide a call tree html page linked to from the bottom the first html page.

–h

Print help information.

–im metric_list

Ignore metrics in the metric_list. These are metrics specified like e.totalcpu and e.bit_fcount and which are documented as "Metric Lists" in the Oracle Developer Studio 12.5: Performance Analyzer. If using more than one metric, separate with a colon. For example,

-im e.totalcpu:e.bit_fcount
–l limit

The –l flag can be used to impose a limit to the number of routines processed. The limit is an integer number. A value of 0 gives unlimited routines. A value of 31 gives 30 routines. If this flag is not used, the default is 100 routines.

–n column_names

Modify column names and column order.

Usually, column names, to the right of metrics, are, in order:

1.        2.                3.        4.
[trimmed] <subroutine name> src|nosrc Caller-callee

Only column 2 varies with the actual subroutine name and column 3 can be either src or nosrc.

column_names is a string like "t:tr,s:sr:ns,c:cc,n".

t: references [trimmed] and the following text, tr, before the comma causes [trimmed] to become [tr].

s: references src|nosrc and the following text, sr:ns, before the comma causes src to become sr and nosrc to become ns.

c: references Caller-callee and the following text, cc, before the comma causes Caller-callee to become cc.

n references <subroutine name> and causes the <subroutine name> to be in the 4th column.

So, now column names, to the right of metrics, are, in order:

1.        2.                3.        4.
[tr]      sr|ns             cc        <subroutine name>
–o directory

Place output from er_html in the specified directory. If not specified, use a directory named ./er.n.html, where n is the first name not in use. If the name is specified, it may have any form, as long as the directory does not exist at the time er_html is invoked.

–O directory

Place output from er_html in the specified directory, overwriting the existing contents of the directory.

–q

Supress information messages which would normally be output to stdout.

–tp percent

The –tp flag can be used to provide er_html with a percentage of metric accountablity. That is, if 80.0 is specified, the inclusion of functions for each metric will take place in sort order until 80.0% of the metric's total. Use like –tp 100.0.

–V

Print the current version. Do not examine further arguments and perform no further processing.

–v

Print the current version and further detailed debugging information about the conversion being run.

Options that can be set in a $HOME/.er_html.rc file:

 

There are a few equivalent options:

command line        .er_html.rc file

-cc                 cc
-ct                 calltree
-im                 imetrics
-l                  limit
-n                  nargs
-tp                 tp

For example

cc none
calltree
imetrics e.bit_fcount
limit 51
nargs t:tr,s:sr:ns,c:cc,n
tp 100.0

Environment Variables

Two environment variables are available: ER_HTML_CMDS and ER_HTML_DIR.

ER_HTML_CMDS

Set to 1 if you want a record of the er_html commands and their timing. This will produce a ER_HTML_CMDS and a ER_HTML_CMDS_TIMING file in the spot results directory. Use the spot_cmds and spot_cmds_timing commands in the spot results directory to get a list of commands spot issued and command timings.

ER_HTML_DIR

Set to the path of er_html if you are using a local copy of er_html, in which case you would invoke spot as follows:

$PATH/bin/er_html

See Also

analyzer (1) , collect (1) , er_archive (1) , er_cp (1) , er_export (1) , er_html_cols (1) , er_html_columnsD (1) , er_html_columnsI (1) , er_mv (1) , er_print (1) , er_rm (1) , er_src (1) , spot (1) , spot_cmds (1) , spot_cmds_timing (1) , spot_diff (1)

Oracle Developer Studio 12.5: Performance Analyzer