<probe_system_perfmeter>.html-report

Synopsis

<probe_system_perfmeter>.html-report [html-dir] [probe-json-file] [graph-spec-json-file] [-open-browser] [-one-page]

Produce a performance report in HTML. The graphs that are included depend on the probes that have been monitored. The <arg>html-dir</arg> argument specifies the directory for the HTML report. If not specified, a temporary directory will be created. The file "index.html" is the start page. The <arg>probe-json-file</arg> can specify an already generated json file containing the probe information, and a report of its data will be presented (instead of the current session). The <arg>graph-spec-json-file</arg> argument points out an json file used for selecting which graphs to produce. If not specified, a default file will be used. The <tt>-open-browser</tt> switch starts a web-browser directly on the generated file. To decrease browser load time, and to make the main-page more high-level, some graphs can request to be added to sub-pages instead of the main page. The <tt>-one-page</tt> switch prevents this and puts all graphs on the same page. The graph specification (see <arg>graphs-spec-json-file</arg) defines which graphs that should be generated. The top-level <tt>"graphs"</tt> key holds a value-list of all defined graphs. In this list, each graph support the following key/value pairs: Key:"description" Type:list or str Default:No description Optional. A textual description of what a graph represents. Key:"title" Type:str Default:None Mandatory. Specifies the main title of the graph. The title is also used to identification, if there is a problem in the json file. Key:"x_axis_title" Type:str Default:None Optional. Specifies the title of the x-axis. If not supplied, the name will be taken from the x-probe's display-name. For histogram-probes' the key-value pairs are unnamed so here the name can represent the key type. Key:"y_axis_title" Type:str Default:None Optional. Specifies the title of the y-axis. If not supplied, the name will be taken from the first y-probe's display-name. For histogram-probes' the key-value pairs are unnamed so here the name can represent value type. Key:"type" Type:str Default:line Valid-values: "bar", "line", "pie" Optional. The type of graph that should be generated. Key:"x_probe" Type:str Default:None Optional. The probe data representing the X-axis values. This is typically sim:sim.time.wallclock-session or sim:sim.time.virtual-session. Key:"y_probes" Type:list or str Default:None The probe(s) representing the data on the Y-axis, for the sampled X-values.It can be specified in multiple ways: - "sim:sim.mips" - The global MIPS data - "cpu0:cpu.mips" - The MIPS data for cpu0 only - "*:cpu.mips" - All objects MIPS data each as its own graph Note, that the wildcard (*) syntax is only used for the complete object, it is not possible to use it as a filter, with prefix or suffix characters. Multiple probes can also be specified as a single-list: - ["sim:sim.exec_mode.interpreter_percent", "sim:sim.exec_mode.jit_percent",", "sim:sim.exec_mode.vmp_percent"] Here three graphs would be shown, however if any prope is missing this is silently ignored. If no probes are found no chart will be generated. It is also possible to add annotations to each graph: - ["sim:sim.mips", ["sim:sim.module_profile"]] Annotation probes provides additional data shown when hovering over a specific point in the graph.In this example, the module profile information is shown when hovering over a data-point in the mips graph. Wildcard (*) is also handled in the annotation probes, however if the probe assigned with annotations, the *-annotation objects must match those in the original probe-object. Key:"histogram_probe" Type:str Default:None If a probe is of histogram type, it holds two datapoints: key and value. Such a probe can be used to show a pie or bar chart from the gathered final value. It can also be used by looking at all samples and stack the bars on-top of each-other. In this case the "x-probe" must also be supplied. Key:"histogram_data_set" Type:str Default:samples Valid-values: "final", "samples" For histogram data, selects if the graph should be based on all the samples or just the final data in the end. Key:"stacked" Type:bool Default:False If graph-data should be placed stacked on-top of each graph, instead as a separate line/bar. Key:"arith_mean" Type:bool Default:False TODO re-implement Key:"percent" Type:bool Default:False Show the Y-data in percent format. Key:"multi_graph" Type:bool Default:False Generate a separate graph for each object. Key:"y_range" Type:list Default:None The range shown on the y-axis by default. If not specified, this will be automatic from the actual y-values given. Key:"min_data_series" Type:int Default:None The minimum number of data-series to draw, for the the graph be shown. Key:"max_data_series" Type:int Default:None The minimum number of data-series to draw, for the the graph be shown. Key:"min_graphs" Type:int Default:None With multi-graph, the minimum graphs that must be generated or all of these graphs are skipped. Key:"max_graphs" Type:int Default:None With multi-graph, the maximum number of graphs that may generated or all of these graphs are skipped. Key:"cutoff_percent" Type:float Default:0.0 Reduce the number of data-series by putting all series that totals in less than the cutoff% value in a special cutoff-bucket Key:"html_page" Type:str Default:index.html The name of the html-page where this graph should be included if not set, defaults to 'index.html' Please note that some key/value pairs only affect certain graphs. Future improvements to the graph generation process may result in changes, additions, or removals of the supported key/value pairs. Therefore, backward compatibility of the JSON file is not guaranteed.

Provided By

probe-monitor

<probe_system_perfmeter>.html-report

Synopsis

Description

Provided By

See Also