https://wiki.openoffice.org/w/api.php?action=feedcontributions&feedformat=atom&user=Mib 2026-05-05T08:51:10Z User contributions MediaWiki 1.35.14 https://wiki.openoffice.org/w/index.php?title=ODFValidator&diff=192892 2011-02-01T08:23:43Z

<p>Mib: Replaced content with &#039;&#039;&#039;&#039;Note: The ODF Validator has been [http://odftoolkit.openoffice.org moved] to the [http://odftoolkit.org ODF Toolkit Union]. The new project is located [http://odftoolkit.o…&#039;</p> <hr /> <div>&#039;&#039;&#039;Note: The ODF Validator has been [http://odftoolkit.openoffice.org moved] to the [http://odftoolkit.org ODF Toolkit Union]. The new project is located [http://odftoolkit.org/projects/conformancetools/pages/ODFValidator here].&#039;&#039;&#039;<br /> <br /> [[Category:ODF]]<br /> [[Category:ODFToolkit]]<br /> [[Category:ODFToolkitTool]]<br /> [[Category:Effort]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=ODFValidator&diff=192891 2011-02-01T08:23:02Z

<p>Mib: </p> <hr /> <div>&#039;&#039;&#039;Note: This page is out of date. The ODF Validator has been [http://odftoolkit.openoffice.org moved] to the [http://odftoolkit.org ODF Toolkit Union]. The new project is located [http://odftoolkit.org/projects/conformancetools/pages/ODFValidator here].&#039;&#039;&#039;<br /> <br /> ODFValidator is a tool that validates OpenDocument files and checks certain conformance criteria.<br /> <br /> ODFValidator is available as a [http://tools.odftoolkit.org/odfvalidator online service] and as a command line tool. This page primarily describes the command line tool. Please visit the [http://tools.odftoolkit.org/odfvalidator ODF Validator] web page for details regarding the online tool.<br /> <br /> == How to start ==<br /> To use the ODFValidator, the following steps are required:<br /> <br /> * Check out the [[#NetBeans Project |&#039;&#039;&#039;odfvalidator&#039;&#039;&#039; NetBeans project]].<br /> * Add the jar files listed under [[#Requirements|Requirements]] to the project&#039;s libraries.<br /> * Get the ODF 1.0, 1,1 and 1.2 [[#Where do I get the schemas?|schemas]], and add the directories where your local copies of the schemas are stored to the &#039;&#039;&#039;schema.user.properties&#039;&#039;&#039; file.<br /> * Get the MathML 1.01 DTD and the MathML 2.0 [[#Where do I get the schemas?|schemas]], and add the directories where you local copies of the schemas are stored to the &#039;&#039;&#039;schema.user.properties&#039;&#039;&#039; file.<br /> * Build the project.<br /> * Choose an arbitray OpenDocument file &#039;&#039;&#039;&lt;odffile&gt;&#039;&#039;&#039;. <br /> * If you are using JRE 1.5, call the ODFValidator with<br /> <br /> java -jar &quot;&lt;path&gt;/odfvalidator.jar&quot; &lt;odffile&gt;<br /> <br /> * If you are using JRE 1.6, call the ODFValidator with<br /> <br /> &lt;pre&gt;<br /> java -Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl<br /> -Dorg.iso_relax.verifier.VerifierFactoryLoader=com.sun.msv.verifier.jarv.FactoryLoaderImpl -jar &quot;&lt;path&gt;/odfvalidator.jar&quot; &lt;odffile&gt;<br /> &lt;/pre&gt;<br /> <br /> == Usage ==<br /> <br /> === Usage Summary ===<br /> <br /> In an Java 1.5 environment, ODFValidator is invoked by the following command:<br /> <br /> java -jar &quot;&lt;path&gt;/odfvalidator.jar&quot;<br /> <br /> In an Java 1.6 environment, the following command line has to be used:<br /> <br /> &lt;pre&gt;<br /> java -Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl<br /> -Dorg.iso_relax.verifier.VerifierFactoryLoader=com.sun.msv.verifier.jarv.FactoryLoaderImpl -jar &quot;&lt;path&gt;/odfvalidator.jar&quot;<br /> &lt;/pre&gt;<br /> <br /> These command lines are abbreviated &#039;&#039;odfvalidator&#039;&#039; from now on.<br /> <br /> The ODFValidator may be called with the following options:<br /> <br /> odfvalidator [-r] [-c|-s] [-d] [-v|-w] [-f &lt;filterfile&gt;] [-x &lt;expclude pattern&gt;] [-o outputfile] [-1.0|-1.1|-1.2] &lt;odffiles&gt;<br /> odfvalidator [-r] [-c|-s] [-d] [-v|-w] [-f &lt;filterfile&gt;] [-x &lt;expclude pattern&gt;] [-o outputfile] -S &lt;schemafile&gt; &lt;odffiles&gt;<br /> odfvalidator [-c|-s] [-v|-w] [-d] [-o outputfile] -C &lt;configfile&gt;<br /> odfvalidator -g &lt;odffiles&gt;<br /> odfvalidator -h<br /> odfvalidator -V<br /> <br /> If no parameters are specified, the files &#039;&#039;&#039;&lt;odffiles&gt;&#039;&#039;&#039; are validated using the schema that belongs to the ODF version of the file. For ODF 1.0 files the ODF 1.0 schema is used, for ODF 1.1 files the ODF 1.1 schema is used, and so on. The version of an ODF file is detected for each file separately.<br /> <br /> The options have the following meaning:<br /> <br /> &#039;&#039;&#039;-c&#039;&#039;&#039;: Apply ODF conformance rules before validation: unknown markup is ignored during validation.<br /> <br /> &#039;&#039;&#039;-d&#039;&#039;&#039;: Use MathML 1.01 DTD rather than MathML 2.0 schema for content.xml of formula documents.<br /> <br /> &#039;&#039;&#039;-f&#039;&#039;&#039;: Ignore error messages specified in &#039;&#039;&#039;&lt;filterfile&gt;&#039;&#039;&#039; (see [[#Specifying a filter file|Specifying a filter file]]).<br /> <br /> &#039;&#039;&#039;-g&#039;&#039;&#039;: Show the generator information of the specified &#039;&#039;&#039;&lt;odffiles&gt;&#039;&#039;&#039; without validation.<br /> <br /> &#039;&#039;&#039;-h&#039;&#039;&#039;: Print a short help.<br /> <br /> &#039;&#039;&#039;-o&#039;&#039;&#039;: Print output into specified file rather than standard output.<br /> <br /> &#039;&#039;&#039;-r&#039;&#039;&#039;: Process directories recursively.<br /> <br /> &#039;&#039;&#039;-c&#039;&#039;&#039;: Use the strict schema for validation.<br /> <br /> &#039;&#039;&#039;-v&#039;&#039;&#039;: Verbose: print information like the generator or the documents that are processed.<br /> <br /> &#039;&#039;&#039;-w&#039;&#039;&#039;: Print warnings.<br /> <br /> &#039;&#039;&#039;-x&#039;&#039;&#039;: Exclude files that match the specified [http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html#sum regular expression] from validation.<br /> <br /> &#039;&#039;&#039;-C&#039;&#039;&#039;: Validate using configuration file &#039;&#039;&#039;&lt;configfile&gt;&#039;&#039;&#039;.<br /> <br /> &#039;&#039;&#039;-S&#039;&#039;&#039;: Use the specified &#039;&#039;&#039;&lt;schemafile&gt;&#039;&#039;&#039; for validation.<br /> <br /> &#039;&#039;&#039;-V&#039;&#039;&#039;: Print version information.<br /> <br /> === Validation using default schemas ===<br /> <br /> The ODF 1.0, ODF 1.1, ODF 1.2 schemas as well as the MathML 1.01 DTD and the MathML 2.0 schema are included in the &#039;&#039;&#039;ODFValidator.jar&#039;&#039;&#039; file. If the ODFValidator is called without the &#039;&#039;&#039;-S&#039;&#039;&#039; or &#039;&#039;&#039;-C&#039;&#039;&#039; options, these schemas are used for validation.<br /> <br /> odfvalidator [-r] [-c|-s] [-d] [-v|-w] [-f &lt;filterfile&gt;] [-x &lt;expclude pattern&gt;] [-o outputfile] [-1.0|-1.1|-1.2] &lt;odffiles&gt;<br /> <br /> &#039;&#039;&#039;&lt;odffiles&gt;&#039;&#039;&#039; is the list of files and directories that should be validated. If a directory is specified, all files that have an OpenDocument extension (like &#039;&#039;&#039;odt&#039;&#039;&#039;, &#039;&#039;&#039;ods&#039;&#039;&#039; or &#039;&#039;&#039;ott&#039;&#039;&#039;) are validated. If &#039;&#039;&#039;-r&#039;&#039;&#039; is specified additionally, all directories are processed recursively.<br /> <br /> By default, the ODFValidator detects the version of the files that shall be validated and chooses the corresponding schema. The command line options &#039;&#039;&#039;-1.0&#039;&#039;&#039;, &#039;&#039;&#039;-1.1&#039;&#039;&#039; and &#039;&#039;&#039;-1.2&#039;&#039;&#039; can be used to specify that the schemas of a particular ODF version should be used for all files, regardless of the version they specify themselves.<br /> <br /> The command line option &#039;&#039;&#039;-d&#039;&#039;&#039; specifies that the MathML 1.01 DTD should be used for the validation of the &#039;&#039;&#039;content.xml&#039;&#039;&#039; of formula documents. Default is to use the MathML 2.0 schema.<br /> <br /> If the &#039;&#039;&#039;-c&#039;&#039;&#039; command line option is specified, unknown markup is ignored as specified in the conformance rules for ODF 1.0/1.1. If the &#039;&#039;&#039;-s&#039;&#039;&#039; command line option is specified, the strict schema is used for validation. If neither &#039;&#039;&#039;-c&#039;&#039;&#039; nor &#039;&#039;&#039;-s&#039;&#039;&#039; are specified, the regular ODF schemas are used, but errors are reported for unknown markup unless it appears in styles or metadata.<br /> <br /> The optional &#039;&#039;&#039;-x&#039;&#039;&#039; switch allows to exclude certain files or directories from the validation. The files that shall be excluded are specified by a [http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html#sum regular expression]. Please note that the full absolute path names of directories and files are matched against this pattern. This means that the regular expression either must include the absolute path of the files and directories that shall be excluded, or must start with &#039;&#039;&#039;.*&#039;&#039;&#039;. The &#039;&#039;&#039;-x&#039;&#039;&#039; option can be specified only once. If several paths shall be excluded, these paths have to be specified in a single regular expression using the &#039;&#039;&#039;|&#039;&#039;&#039; operator.<br /> <br /> If &#039;&#039;&#039;-w&#039;&#039;&#039; is specified additionally, not only validation errors are reported, but also warnings.<br /> <br /> If &#039;&#039;&#039;-v&#039;&#039;&#039; is specified additionally, not only validation errors and warnings are reported, but also the generator stored in the manifest, MIME types, the files that are processed, etc.<br /> <br /> If the &#039;&#039;&#039;-o&#039;&#039;&#039; option is present, all messages go into the specified file. Otherwise, they are printed to standard out. It is possible to exclude known validation errors from the output by specifying a [[#Specifying a filter file|filter file]] using the &#039;&#039;&#039;-f&#039;&#039;&#039; option.<br /> <br /> === Validation using a non-default schema ===<br /> <br /> Tho specify the schema that is used for &#039;&#039;&#039;meta-xml&#039;&#039;&#039;, &#039;&#039;&#039;content.xml&#039;&#039;&#039;, &#039;&#039;&#039;styles.xml&#039;&#039;&#039; and &#039;&#039;&#039;settings.xml&#039;&#039;&#039; on the command line, ODFValidator has to be called with the following parameters:<br /> <br /> odfvalidator [-r] [-c|-s] [-d] [-v|-w] [-f &lt;filterfile&gt;] [-x &lt;expclude pattern&gt;] [-o outputfile] -S &lt;schemafile&gt; &lt;odffiles&gt;<br /> <br /> &#039;&#039;&#039;&lt;schemafile&gt;&#039;&#039;&#039; is the schema that shall be used.<br /> <br /> All other command line option are as described in [[#Validation using default schemas|Validation using default schemas]].<br /> <br /> === Validation using a configuration file ===<br /> <br /> The schemas and the files that should be validated can be specified in a configuration file. A configuration file is a Java XML properties file as described in the [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html Java 2 API documentation]. The following properties are supported:<br /> <br /> * &#039;&#039;&#039;strict-schema&#039;&#039;&#039;: Specifies the strict schema to be used.<br /> * &#039;&#039;&#039;manifest-schema&#039;&#039;&#039;: Specifies the manifest schema to be used.<br /> * &#039;&#039;&#039;mathml-schema&#039;&#039;&#039;: Specifies the MathML 1.01 schema to be used.<br /> * &#039;&#039;&#039;mathml2-schema&#039;&#039;&#039;: Specifies the MathML 2 schema to be used.<br /> * &#039;&#039;&#039;path*&#039;&#039;&#039;: All properties whose names start with &quot;path&quot; are considered to be files or directories that shall be validated. <br /> * &#039;&#039;&#039;recursive&#039;&#039;&#039;: This boolean property specifies whether directories are scanned recursively. It takes the values &#039;&#039;&#039;true&#039;&#039;&#039; and &#039;&#039;&#039;false&#039;&#039;&#039;.<br /> * &#039;&#039;&#039;exclude&#039;&#039;&#039;: Specifies files and directories that shall be excluded as a [http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html#sum regular expression]. See description of [[#Specifying the schema on the command line|&#039;&#039;&#039;-x&#039;&#039;&#039; option]].<br /> * &#039;&#039;&#039;filter&#039;&#039;&#039;: Specifies [[#Specifying a filter file|filter file]].<br /> <br /> A sample configuration file looks like this:<br /> <br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br /> &lt;!DOCTYPE properties SYSTEM &quot;http://java.sun.com/dtd/properties.dtd&quot;&gt;<br /> &lt;properties&gt;<br /> &lt;entry key=&quot;strict-schema&quot;&gt;/home/odf11-cd2/msv/OpenDocument-strict-schema-v1.1-cd2.rng&lt;/entry&gt;<br /> &lt;entry key=&quot;manifest-schema&quot;&gt;/home/odf11-cd2/msv/OpenDocument-manifest-schema-v1.1-cd2.rng&lt;/entry&gt;<br /> &lt;entry key=&quot;mathml-schema&quot;&gt;/home/odf11-cd2/msv/mathml2.xsd&lt;/entry&gt;<br /> &lt;entry key=&quot;path1&quot;&gt;/home/testdocs&lt;/entry&gt;<br /> &lt;entry key=&quot;path2&quot;&gt;/home/temp&lt;/entry&gt;<br /> &lt;/properties&gt;<br /> <br /> == Specifying a filter file ==<br /> <br /> It is possible to omit the output of known validation errors by adding their error message to a so called filter file. A filter file is an XML file, which matches the following [http://www.relaxng.org/compact-tutorial-20030326.html Relax-NG Compact] schema:<br /> <br /> start = filter<br /> filter = element filter { filter-attlist, filter-entry+ }<br /> filter-attlist &amp;= empty<br /> filter-entry = element filter-entry { filter-entry-attlist, text }<br /> filter-entry-attlist &amp;=<br /> attribute task-id {<br /> xsd:string { pattern = &#039;[a-z]?[0-9]+&quot;&#039; }<br /> }<br /> filter-entry-attlist &amp;= attribute resolved-in { xsd:integer }?<br /> <br /> A sample filter file is<br /> <br /> &lt;filter&gt;<br /> &lt;!-- CWS impress25/SRC680m72 --&gt;<br /> &lt;filter-entry task-id=&quot;i38753&quot; resolved-in=&quot;8864&quot;&gt;attribute &quot;presentation:display-header&quot; has a bad value. Possible values are: false,true&lt;/filter-entry&gt;<br /> &lt;/filter&gt;<br /> <br /> Each &#039;&#039;&#039;&lt;filter-entry&gt;&#039;&#039;&#039; element described one message that shall be excluded. The message itself is the element content. The mandatory &#039;&#039;&#039;task-id&#039;&#039;&#039; attribute includes the task which resolves the validation error, or that has been submitted for the validation error if it has not been resolved already. <br /> <br /> The optional &#039;&#039;&#039;resolved-in&#039;&#039;&#039; attribute contains the build-id of the master where the validation error has been resolved. <br /> Error messages are only omited if the &#039;&#039;&#039;resolved-in&#039;&#039;&#039; attribute is provided, or if the build-id is lower than the one which is stored in the &#039;&#039;&#039;&lt;meta:generator&gt;&#039;&#039;&#039; element of the file that is validated. This means that a validation error is not omitted if it occurs in a file which has been saved with an OOo version where the bug shall be resolved already.<br /> <br /> If a error message is omited, a warning is printed that contains the task-id specified in the filter file. Please note that warning are only printed if either the &#039;&#039;&#039;-w&#039;&#039;&#039; or the &#039;&#039;&#039;-v&#039;&#039;&#039; switch is present.<br /> <br /> A filter file is specified using the &#039;&#039;&#039;-f&#039;&#039;&#039; command line option or the &#039;&#039;&#039;filter&#039;&#039;&#039; property in the configuration file.<br /> <br /> <br /> == Where do I get the schemas? ==<br /> <br /> The OpenDocument schemas are those provided on the [[http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office OASIS OpenDocument technical Committee]] page.<br /> <br /> &#039;&#039;&#039;Note:&#039;&#039;&#039; Due to an issue in MSV, errors are reported that do not exist. To avoid this, the schemas build into ODFValidator have been modified.<br /> <br /> The MathML DTD that is included in the ODFValidator us the one that is included in the &#039;&#039;&#039;/share/dtd/math/1_01/&#039;&#039;&#039; folder of each OOo/StarOffice installation.<br /> <br /> == Requirements ==<br /> <br /> ODFValidator requires J2RE 1.5 or J2RE 1.6. For J2RE 1.6, the following options have to be included into the &#039;&#039;&#039;java&#039;&#039;&#039; command line:<br /> <br /> &lt;pre&gt;<br /> -Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl<br /> -Dorg.iso_relax.verifier.VerifierFactoryLoader=com.sun.msv.verifier.jarv.FactoryLoaderImpl<br /> &lt;/pre&gt;<br /> <br /> <br /> ODFValidator further requires the following packages:<br /> <br /> * [https://msv.dev.java.net/ MSV]. &#039;&#039;&#039;msv.jar&#039;&#039;&#039;, &#039;&#039;&#039;isorelax.jar&#039;&#039;&#039;, &#039;&#039;&#039;relaxngDatatype.jar&#039;&#039;&#039; and &#039;&#039;&#039;xsdlib.jar&#039;&#039;&#039; included in the MSV distribution must be added to the project&#039;s libraries and must be in the classpath or a folder called &#039;&#039;&#039;lib&#039;&#039;&#039; that is next to the &#039;&#039;&#039;odfvalidator.jar&#039;&#039;&#039; at runtime. <br /> * [https://isorelax-jaxp-bridge.dev.java.net/ ISORELAX JARV -&gt; JAXP 1.3 Xml Validation Engine Adaptor]. &#039;&#039;&#039;isorelax-jaxp-bridge-1.0.jar&#039;&#039;&#039; must be added to the project&#039;s libraries and must be in the classpath or a folder called &#039;&#039;&#039;lib&#039;&#039;&#039; that is next to the &#039;&#039;&#039;odfvalidator.jar&#039;&#039;&#039; at runtime. <br /> * [http://odftoolkit.openoffice.org/servlets/ProjectDocumentList?folderID=759&amp;expandFolder=759&amp;folderID=0 ODFDOM] &#039;&#039;&#039; odfdom.jar&#039;&#039;&#039; from [http://odftoolkit.openoffice.org/servlets/ProjectDocumentList?folderID=759&amp;expandFolder=759&amp;folderID=0 ODFDOM] must be added to the project&#039;s libraries and must be in the classpath or a folder called &#039;&#039;&#039;lib&#039;&#039;&#039; that is next to the &#039;&#039;&#039;odfvalidator.jar&#039;&#039;&#039; at runtime. <br /> <br /> &#039;&#039;&#039;Warning:&#039;&#039;&#039; Make sure you use an up-to-date release of MSV. Older versions (before msv-20061103) report errors for the OpenDocument schema itself.<br /> <br /> == NetBeans Project ==<br /> <br /> The &#039;&#039;&#039;ODFValidator&#039;&#039;&#039; [http://odftoolkit.openoffice.org/source/browse/odftoolkit/tools/odfvalidator/ source code] is located in the &#039;&#039;tools&#039;&#039; folder of the [http://odftoolkit.openoffice.org OpenOffice.org ODF Toolkit Project].<br /> <br /> The &#039;&#039;&#039;ODFValidator&#039;&#039;&#039; ia a NebBeans project. To work with the project, just open the project folder.<br /> <br /> [[Category:ODF]]<br /> [[Category:ODFToolkit]]<br /> [[Category:ODFToolkitTool]]<br /> [[Category:Effort]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123843 2009-05-08T13:43:33Z

<p>Mib: /* save-compact */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -p thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -p files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> RTLLog2ODF -p save-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> RTLLog2ODF -p load-summary-writer &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary-writer &lt;log files&gt;<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> RTLLog2ODF -p save-summary-writer &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary-writer &lt;log files&gt;<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> RTLLog2ODF -p load-compact &lt;log files&gt;<br /> RTLLog2ODF -p load-compact &lt;dir&gt;<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> Instead of a list of log files, a directory that contains log files may be specified.<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> RTLLog2ODF -p load-compact &lt;log files&gt;<br /> RTLLog2ODF -p load-compact &lt;dir&gt;<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> Instead of a list of log files, a directory that contains log files may be specified.<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123842 2009-05-08T13:42:40Z

<p>Mib: /* load-compact */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -p thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -p files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> RTLLog2ODF -p save-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> RTLLog2ODF -p load-summary-writer &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary-writer &lt;log files&gt;<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> RTLLog2ODF -p save-summary-writer &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary-writer &lt;log files&gt;<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> RTLLog2ODF -p load-compact &lt;log files&gt;<br /> RTLLog2ODF -p load-compact &lt;dir&gt;<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> Instead of a list of log files, a directory that contains log files may be specified.<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123841 2009-05-08T13:40:47Z

<p>Mib: /* save-writer-summary */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -p thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -p files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> RTLLog2ODF -p save-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> RTLLog2ODF -p load-summary-writer &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary-writer &lt;log files&gt;<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> RTLLog2ODF -p save-summary-writer &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary-writer &lt;log files&gt;<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123840 2009-05-08T13:40:08Z

<p>Mib: /* load-writer-summary */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -p thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -p files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> RTLLog2ODF -p save-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> RTLLog2ODF -p load-summary-writer &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary-writer &lt;log files&gt;<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123839 2009-05-08T13:39:21Z

<p>Mib: /* save-summary */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -p thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -p files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> RTLLog2ODF -p save-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p save-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123837 2009-05-08T13:38:34Z

<p>Mib: /* files */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -p thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -p files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123836 2009-05-08T13:38:17Z

<p>Mib: /* threads */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -p thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -t files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123834 2009-05-08T13:37:56Z

<p>Mib: /* load-summary */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -t thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -t files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> RTLLog2ODF -p load-summary &lt;log file&gt; &lt;comparison log file&gt;<br /> RTLLog2ODF -p load-summary &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123833 2009-05-08T13:36:26Z

<p>Mib: /* files */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -t thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> RTLLog2ODF -t files &lt;log files&gt;<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123832 2009-05-08T13:35:54Z

<p>Mib: /* threads */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> RTLLog2ODF -t thread &lt;log files&gt;<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123831 2009-05-08T13:27:40Z

<p>Mib: /* Profiles */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose load times are recorded in the log file, as well as the load times itself. The corresponding command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet. Each sheets lists the file whose save times are recorded in the log file, as well as the save times itself. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === load-compact ===<br /> <br /> Displays all files that are loaded in any of the given log files. For each such file, a row is created that list <br /> * the load duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the load speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> === save-compact ===<br /> <br /> Displays all files that are saved in any of the given log files. For each such file, a row is created that list <br /> * the save duration, <br /> * the file size (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> * the save speed (compressed and uncompressed, where uncompressed means the sum of the content.xml, styles.xml, meta.xml and settings.xml sizes)<br /> <br /> This is a build-in profile for which no corresponding command line does exist.<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123817 2009-05-08T12:17:33Z

<p>Mib: /* XPath Expressions */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the sum of the uncompressed sizes of the content.xml, styles.xml, meta.xml and settings.xml sub files is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODF files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123797 2009-05-08T11:05:53Z

<p>Mib: /* Profiles */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the uncompressed size of the zip file is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODF files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;none&#039;&quot;<br /> <br /> This profile is useful to compare the save times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === load-writer-summary ===<br /> <br /> Like [[#load-summary|&lt;tt&gt;load-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Like [[#save-summary|&lt;tt&gt;save-summary&lt;/tt&gt;]], except that te times for &lt;tt&gt;SwXMLWriter::WriteThroughComponent&lt;/tt&gt; method calls are included. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123796 2009-05-08T10:57:15Z

<p>Mib: /* load-writer-summary */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the uncompressed size of the zip file is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> This profile is useful to compare the load times between two log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123795 2009-05-08T10:56:48Z

<p>Mib: /* load-writer-summary */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the uncompressed size of the zip file is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The times for &lt;tt&gt;ReadThroughComponent&lt;/tt&gt; function calls are included The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> This profile is useful to compare the load times between to log files. If exactly two log file are specified, then a third sheet is inserted that summarizes the changes between the two log files.<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123794 2009-05-08T10:52:36Z

<p>Mib: /* XPath Expressions */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or an URI.<br /> |-<br /> |&lt;tt&gt;rtllog:filesize(&#039;&#039;path&#039;&#039;[,&#039;&#039;uncompressed&#039;&#039;])&lt;/tt&gt;<br /> |returns the size of the file &#039;&#039;path&#039;&#039;. &#039;&#039;path&#039;&#039; may be a filesystem path or a file URI. &#039;&#039;uncompressed&#039;&#039; is a Boolean parameter. If its value is &#039;&#039;true&#039;&#039; and if the file denoted by &#039;&#039;path&#039;&#039; is a zip file, then the uncompressed size of the zip file is returned.<br /> |-<br /> |&lt;tt&gt;rtllog:qtim(&#039;&#039;string&#039;&#039;)&lt;/tt&gt;<br /> |if the first and last characters of &#039;&#039;string&#039;&#039; are both &#039; or &quot;, then &#039;&#039;string&#039;&#039; is returned without its first and last character. Otherwise &#039;&#039;string&#039;&#039; is returned unmodified.<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123790 2009-05-08T10:41:11Z

<p>Mib: /* Command Line */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; -G &lt;xpath&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> If &#039;&#039;&#039;-c&#039;&#039;&#039; is provided, a row is added to the sheets only for entries specified by the &#039;&#039;&#039;-g&#039;&#039;&#039; option. The header of the row is specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option. Both options take XPath expressions. &#039;&#039;&#039;-g&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039;. &#039;&#039;&#039;-G&#039;&#039;&#039; is evaluated with the context nodes specified by &#039;&#039;&#039;-g&#039;&#039;&#039;.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=123786 2009-05-08T10:31:45Z

<p>Mib: /* Command Line */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -c [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=123781 2009-05-08T10:16:09Z

<p>Mib: /* Implementation */</p> <hr /> <div>{{Performance}}<br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 task 100301] which is assigned to CWS perftest08.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is called &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; and is described [[RTLLog2ODF|here]].</div>

Mib https://wiki.openoffice.org/w/index.php?title=Xml&diff=123575 2009-05-07T07:11:52Z

<p>Mib: </p> <hr /> <div>Lead: Michael Brauer<br /> <br /> Co-Lead: Svante Schubert<br /> <br /> These are the Wiki pages of the [http://xml.openoffice.org OpenOffice.org XML Project].<br /> <br /> The following information can be found on these pages:<br /> <br /> __TOC__<br /> <br /> {{:Xml/Efforts}}<br /> {{:Xml/ContributionAreas}}<br /> {{:Xml/Tools}}<br /> {{:Xml/ArticlesAndBooks}}<br /> {{:Xml/Research}}<br /> {{:Xml/Filters}}<br /> {{:Xml/Modules}}<br /> <br /> [[Category:Project]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=Xml/Tools&diff=123574 2009-05-07T07:10:37Z

<p>Mib: /* External OpenDocument Tools */</p> <hr /> <div>= OpenDocument Tools at OpenOffice.org =<br /> <br /> &lt;table border&gt;<br /> &lt;tr&gt;<br /> &lt;th colspan=&quot;2&quot;&gt;Tools at OpenOffice.org&lt;/th&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;th&gt;Tool&lt;/th&gt;<br /> &lt;th&gt;Summary&lt;/th&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://xml.openoffice.org/saxecho/ SAXEcho]&lt;/td&gt;<br /> &lt;td&gt;SAXEcho is a tool to be used with the OpenOffice.org application. It allows to view the XML representation of a document at runtime. It can either display the native XML file format representation of an in-memory document, or the output of an an XSLT transformation on said document. It is written in Java.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://xml.openoffice.org/xfilter.html xfilter tool]&lt;/td&gt;<br /> &lt;td&gt;This page documents the &lt;code&gt;xfilter&lt;/code&gt; tool, which lets you execute XML-based filters (as explained in the [http://xml.openoffice.org/filter Filters using XML] document) outside of OpenOffice.org or StarOffice.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;/table&gt;<br /> <br /> = External OpenDocument Tools =<br /> <br /> &lt;table border&gt;<br /> &lt;tr&gt;<br /> &lt;th colspan=&quot;2&quot;&gt;External Tools&lt;/th&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;th&gt;Tool&lt;/th&gt;<br /> &lt;th&gt;Summary&lt;/th&gt;<br /> &lt;/tr&gt;<br /> <br /> &lt;tr&gt;<br /> &lt;td&gt;[http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM]&lt;/td&gt;<br /> &lt;td&gt;&lt;b&gt;ODFDOM&lt;/b&gt; is an OpenDocument (ODF) framework. It&#039;s purpose is to provide an easy common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://odftoolkit.org/projects/odftoolkit/pages/ODFValidator ODF Validator]&lt;/td&gt;<br /> &lt;td&gt;&lt;b&gt;ODF Validator&lt;/b&gt; is a Java tool that validates OpenDocument files and checks them for certain conformance criteria.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://tools.odftoolkit.org/odfvalidator ODF Online Validator]&lt;/td&gt;<br /> &lt;td&gt;&lt;b&gt;ODF Online Validator&lt;/b&gt; is an online validation and conformance check tool for ODF documents.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://odftoolkit.org/projects/odftoolkit/pages/ODFXSLTRunner ODF XSLT Runner]&lt;/td&gt;<br /> &lt;td&gt;&lt;b&gt;ODF XSLT Runner&lt;/b&gt; is a small Java command line application that allows you to apply XSLT stylesheets to XML streams included in ODF packages without extracting them from the package.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://odftoolkit.org/projects/odftoolkit/pages/ODFXSLTRunnerTask ODF XSLT Runner Task]&lt;/td&gt;<br /> &lt;td&gt;&lt;b&gt;ODF XSLT Runner Task&lt;/b&gt; is a task definition for Ant which allows to apply XSLT stylesheets to ODF documents similar to Ant&#039;s build-in &amp;lt;xslt&amp;gt; task. &lt;/td&gt;<br /> &lt;/tr&gt;<br /> <br /> &lt;tr&gt;<br /> &lt;td&gt;[http://search.cpan.org/dist/OpenOffice-OODoc The Perl OpenDocument Connector]&lt;/td&gt;<br /> &lt;td&gt;This toolkit allows direct OpenDocument file update and creation from Perl scripts. It works with the main document classes (texts, spreadsheets, presentations, and drawings), and provides an easy access to a large set of content and presentation elements.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://zope.org/Members/struktur/CMFOODocumentV02 CMFOODocument]&lt;/td&gt;<br /> &lt;td&gt;OpenOffice Documents for [http://www.icoya.com icoya Content &amp; Collaboration Management] - With CMFOODocument OpenOffice Writer files can easily be integrated inside your Plone site. The OO-Documents are converted by XSL transformation into HTML.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;tr&gt;<br /> &lt;td&gt;[http://ooolib.sourceforge.net/ OpenOffice.org Perl Library]&lt;/td&gt;<br /> &lt;td&gt;The OpenOffice.org Perl Library (ooolib) can be used to create simple OpenOffice.org Calc spreadsheet and Writer text documents.&lt;/td&gt;<br /> &lt;/tr&gt;<br /> &lt;/table&gt;</div>

Mib https://wiki.openoffice.org/w/index.php?title=Xml/Efforts&diff=123179 2009-05-06T13:21:36Z

<p>Mib: /* Current Efforts of the XML Project */</p> <hr /> <div>= Current Efforts of the XML Project =<br /> <br /> * [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office OpenDocument]: Contributions to the formula specification that is developed by the [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office-formula OASIS OpenDocument Formula Subcommittee].<br /> <br /> * [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office OpenDocument]: Contributions to the metadata enhancements for OpenDocument v1.2 that are developed by the [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office-formula OASIS OpenDocument Metadata Subcommittee].<br /> <br /> * [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office OpenDocument]: Contributions to the OpenDocument v1.2 specification, including reviews of the specification documents.<br /> <br /> * [http://performance.openoffice.org Performance improvements]: The XML project participates in the [http://performance.openoffice.org Performance project]</div>

Mib https://wiki.openoffice.org/w/index.php?title=Xml/Efforts&diff=123176 2009-05-06T13:19:23Z

<p>Mib: /* Current Efforts of the XML Project */</p> <hr /> <div>= Current Efforts of the XML Project =<br /> <br /> * [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office OpenDocument]: Contributions to the formula specification that is developed by the [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office-formula OASIS OpenDocument Formula Subcommittee].<br /> <br /> * [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office OpenDocument]: Contributions to the metadata enhancements for OpenDocument v1.2 that are developed by the [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office-formula OASIS OpenDocument Metadata Subcommittee].<br /> <br /> * [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office OpenDocument]: Contributions to the OpenDocument v1.2 specification, including reviews of the specification documents.</div>

Mib https://wiki.openoffice.org/w/index.php?title=Performance/People&diff=116174 2009-03-18T10:45:41Z

<p>Mib: /* People working in the performance project */</p> <hr /> <div>{{Performance}}<br /> === People working in the performance project ===<br /> <br /> {| class=&quot;prettytable sortable&quot;<br /> |-<br /> ! Name || OOo user || IRC nick name || Role and tasks in performance project || Affiliation<br /> |-<br /> | [[User:Sb|Stephan Bergmann]]|| sb || sb || Startup performance (Unix) || Sun Microsystems<br /> |-<br /> | [[User:mib|Michael Brauer]]|| mib|| odf-mib || [[RTLLogFileAnalysis|Analyzing load/save performance]], [[RTLLog2ODF|analysis tools]] || Sun Microsystems<br /> |-<br /> | Xiuzhi Cheng|| xzcheng || xiuzhi|| || Beijing Redflag CH2000<br /> |-<br /> | [[User:cd|Carsten Driesner]]|| cd|| cd_oo || Startup performance (Windows) || Sun Microsystems<br /> |-<br /> | Heng Li|| LiHeng || liheng || Performance Project Lead || Beijing Redflag CH2000<br /> |-<br /> | [[User:Pj|Peter Junge]]|| pj || peter13j || Observer || Beijing Redflag CH2000<br /> |-<br /> | [[User:Dl|Dieter Loeschky]]|| dl|| DieterLoeschky || Performance Project Lead || Sun Microsystems<br /> |-<br /> | [[User:ErAck|Eike Rathke]] || er || erAck || Calc performance || Sun Microsystems<br /> |-<br /> | [[User:mt|Malte Timmermann]]|| mt|| Malte || Analyzing and trying different stuff || Sun Microsystems<br /> |-<br /> | [[User:yugq|Guoqiang Yu]]|| yugq || yugq || Startup, load and save || Beijing Redflag CH2000<br /> |-<br /> | [[User:liangjun|Liangjun Zeng]]|| zengliangjun || liangjun || Startup || Beijing Redflag CH2000<br /> |-<br /> | [[User:fl|Frank Loehmann]]|| fl || frankl || UX || Sun Microsystems<br /> |-<br /> |}<br /> <br /> List of all members registered to the performance project: [http://performance.openoffice.org/servlets/ProjectMemberList Project Member List]<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=116173 2009-03-18T10:43:50Z

<p>Mib: /* Introduction */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116172 2009-03-18T10:41:15Z

<p>Mib: /* Implementation */</p> <hr /> <div>{{Performance}}<br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 task 100301] which is assigned to CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is called &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; and is described [[RTLLog2ODF|here]].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=116171 2009-03-18T10:40:05Z

<p>Mib: /* */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the RTL_LOGFILE feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].<br /> <br /> [[Category:Performance]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=116170 2009-03-18T10:39:25Z

<p>Mib: /* Introduction */</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is an analysis tool for log files created using the RTL_LOGFILE feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLog2ODF&diff=116169 2009-03-18T10:39:06Z

<p>Mib: New page: == Introduction == &#039;&#039;&#039;RTLLog2ODF&#039;&#039; is an analysis tool for log files created using the RTL_LOGFILE feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which th...</p> <hr /> <div>== Introduction ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039; is an analysis tool for log files created using the RTL_LOGFILE feature. It is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> == Source Code ==<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> == Building RTLLog2ODF ==<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> == Command Line ==<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> == XPath Expressions ==<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> == Profiles ==<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> === threads ===<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> === files ===<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> === load-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> === save-writer-summary ===<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> == Intermediate XML File Format==<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> === &lt;root&gt; ===<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> === &lt;comment&gt; ===<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> === &lt;file&gt; ===<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> === &lt;block&gt; ===<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> === &lt;stamp&gt; ===<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116168 2009-03-18T10:34:23Z

<p>Mib: /* Implementation */</p> <hr /> <div>{{Performance}}<br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 task 100301] which is assigned to CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> [[RTLLog2ODF]]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116167 2009-03-18T10:34:00Z

<p>Mib: /* RTL_LOGFILE Analysis Tool (RTLLog2ODF) */</p> <hr /> <div>{{Performance}}<br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 task 100301] which is assigned to CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> [RTLLog2ODF]</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116166 2009-03-18T10:31:44Z

<p>Mib: /* Source Code */</p> <hr /> <div>{{Performance}}<br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 task 100301] which is assigned to CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Building RTLLog2ODF ===<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is written in Java. The &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder in [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository] contains a NetBeans project where the usual NetBeans targets can be used to build &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039;. Alternatively, Ant can be called directly with the &lt;tt&gt;build.xml&lt;/tt&gt; file which is located in the &lt;tt&gt;rtllog2odf&lt;/tt&gt; folder.<br /> <br /> &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; requires [http://odftoolkit.org/projects/odftoolkit/downloads/7/download odfdom.jar] from the [http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM ODFDOM project] at build and at run time.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === XPath Expressions ===<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116165 2009-03-18T10:16:32Z

<p>Mib: /* RTL_LOGFILE Analysis */</p> <hr /> <div>{{Performance}}<br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 task 100301] which is assigned to CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === XPath Expressions ===<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116164 2009-03-18T10:01:05Z

<p>Mib: /* Implementation */</p> <hr /> <div>{{Performance}}<br /> = RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 task 100301] which is assigned to CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === XPath Expressions ===<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116163 2009-03-18T10:00:39Z

<p>Mib: /* Implementation */</p> <hr /> <div>{{Performance}}<br /> = RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This implementation is in progress as [http://qa.openoffice.org/issues/show_bug.cgi?id=100301 RTL_LOGFILE task 100301] which is assigned to CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === XPath Expressions ===<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116162 2009-03-18T09:59:32Z

<p>Mib: /* Implementation */</p> <hr /> <div>{{Performance}}<br /> = RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved. This is done as [[http://qa.openoffice.org/issues/show_bug.cgi?id=100301 RTL_LOGFILE task 100301] which is resolved in CWS mib10.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === XPath Expressions ===<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116160 2009-03-18T09:40:53Z

<p>Mib: /* Implementation */</p> <hr /> <div>{{Performance}}<br /> = RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances. This tools is described below.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === XPath Expressions ===<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116159 2009-03-18T09:39:32Z

<p>Mib: /* Command Line */</p> <hr /> <div>{{Performance}}<br /> = RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === XPath Expressions ===<br /> <br /> The [http://www.w3.org/TR/xpath XPath] expressions that control the generation of the spreadsheet support the following extension functions:<br /> <br /> {| border<br /> |&#039;&#039;&#039;Name&#039;&#039;&#039;<br /> |&#039;&#039;&#039;Descriptions&#039;&#039;&#039;<br /> |-<br /> |&lt;tt&gt;rtllog:filename(&#039;&#039;path&#039;&#039;)&lt;/tt&gt;<br /> |returns the filename part of &#039;&#039;path&#039;&#039;<br /> |}<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=116158 2009-03-18T09:32:40Z

<p>Mib: /* RTL_LOGFILE Analysis Tool */</p> <hr /> <div>{{Performance}}<br /> = RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool (RTLLog2ODF) ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL log files as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2ODF&#039;&#039;&#039; is available in the [http://performance.openoffice.org/source/browse/performance/ performance projects SVN repository].<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2odf.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2odf.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2odf.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115553 2009-03-11T15:51:59Z

<p>Mib: /* Command Line */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; will be committed soon.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with a &#039;&#039;&#039;-t&#039;&#039;&#039; options that results in two sheets, then an additional sheet is generated that list the time differences between the sheets for the two log files.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115552 2009-03-11T15:39:35Z

<p>Mib: /* Command Line */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; will be committed soon.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided with exactly two RTL log files as input files, then an additional sheet is generated that <br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115551 2009-03-11T15:37:34Z

<p>Mib: /* Source Code */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; will be committed soon.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115550 2009-03-11T15:37:19Z

<p>Mib: /* RTL_LOGFILE Analysis Tool */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Source Code ===<br /> <br /> The source code for &#039;&#039;&#039;RtlLog2XML&#039;&#039;&#039; will be committed soon.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115549 2009-03-11T15:34:53Z

<p>Mib: /* Command Line */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath]] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115548 2009-03-11T15:34:19Z

<p>Mib: /* Command Line */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a [[#Profiles|profile]] is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Profiles ===<br /> <br /> The following profiles are predefined. To get a list of all profiles that are available &#039;&#039;&#039;RTLLog2XML&#039;&#039;&#039; may be called without arguments.<br /> <br /> ==== threads ====<br /> <br /> Displays the data of each thread on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//thread&quot; -T &quot;concat(&#039;Thread &#039;,@thread-id)&quot;<br /> <br /> ==== files ====<br /> <br /> Displays the data of each log file on a separate sheet. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;@name&quot;<br /> <br /> ==== load-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are loaded. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;::SfxFrameLoader::load&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::LoadOwnFormat&#039; and starts-with(.,&#039;loading &#039;)],&#039; &#039;))&quot;<br /> -i &quot;@function=&#039;ReadThroughComponent&#039;&quot;<br /> <br /> ==== save-writer-summary ====<br /> <br /> Displays the data of each log file on a separate sheet, where the data on the sheets is grouped by the ODT files that are saved. The corresponding options command line options are:<br /> <br /> -t &quot;//file&quot; -T &quot;rtllog:filename(@name)&quot; -g &quot;.//block[@function=&#039;SfxObjectShell::SaveTo_Impl&#039;]&quot; <br /> -G &quot;rtllog:filename(substring-after(.//stamp[@function=&#039;SfxObjectShell::SaveTo_Impl&#039; and starts-with(.,&#039;saving &#039;)],&#039; &#039;))&quot; <br /> -i &quot;@function=&#039;SwXMLWriter::WriteThroughComponent&#039;&quot;<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115546 2009-03-11T15:24:55Z

<p>Mib: /* Command Line */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file]], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a profile is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115545 2009-03-11T15:24:20Z

<p>Mib: /* RTL_LOGFILE Analysis */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the [[#Intermediate_XML_File_Format|intermediate XML file] that is matched by the [http://www.w3.org/TR/xpath XPath] expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The [http://www.w3.org/TR/xpath XPath] expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the [[#Intermediate_XML_File_Format|intermediate XML file], a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an [http://www.w3.org/TR/xpath XPath] expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean [http://www.w3.org/TR/xpath XPath] expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an [[#Intermediate_XML_File_Format|XML file]] only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a profile is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib https://wiki.openoffice.org/w/index.php?title=RTLLogFileAnalysis&diff=115544 2009-03-11T15:19:49Z

<p>Mib: /* Intermediate XML file */</p> <hr /> <div>= RTL_LOGFILE Analysis =<br /> <br /> == Introduction ==<br /> <br /> [http://tools.openoffice.org/profiling/profiling-howto.html RTL_LOGFILE] is a developer feature of OpenOffice.org that can be used to get wall clock based time stamps for particular code points. It can be used for instance in automated performance tests. This section describes its use for profiling load and save operations of ODF documents.<br /> <br /> == Use Cases ==<br /> <br /> The use of RTL_LOGFILE is advantageous, compared to for instance the use of a profiler, if the performance data is required for a large amount of load or save operations, or if the performance of two OpenOffice.org builds shall be compared with as little effort as possible. The data that can be collected by RTL_LOGFILE is neither precise nor detailed enough to actually profile for instance the loading or saving a particular document, but it is still is detailed and precise enough for a rough analysis, for regression tests or performance metrics, or to figure out which effect a particular performance improvement has for a large set of data.<br /> <br /> Possible use cases are:<br /> <br /> * The comparison of load save times for a large set of document between a master build and a CWS.<br /> * The comparison of load save times for a large set of document between a master build and a developer build that implements a particular improvement.<br /> * To provide metrics that show performance improvements that have been achieved.<br /> * To find documents whose load or save time is significant above or below the average, and which therefore are either <br /> ** worth a deeper investigation (with other tools), or <br /> ** appear to be non appropriate as test documents for a performance improvement that is assumed to effect all documents.<br /> <br /> == Implementation ==<br /> <br /> In order to use RTL_LOGFILE as described above, two tasks need to be completed:<br /> <br /> * Additional RTL_LOGFILE macros have to be inserted into the OpenOffice.org source code that provide the information which documents have been loaded or saved.<br /> * A configurable analysis tool is required that allows comparisons between load/save data for individual documents, and between load/save data for individual OpenOffice.org instances.<br /> <br /> Both implementations are in progress.<br /> <br /> == RTL_LOGFILE Analysis Tool ==<br /> <br /> === Introduction ===<br /> <br /> The new analysis tool is similar to the existing RTL_LOGFILE analysis perl scripts, from which the parser logic has been adopted. It takes one or more RTL_LOGILEs as input, and creates an ODF spreadsheet. How the performance data is presented in the spreadsheet can be controlled by a set of [http://www.w3.org/TR/xpath XPath] expressions.<br /> <br /> The creation of the spreadsheet takes places in two steps. In a first step, the text based RTL log file is converted into an [[#Intermediate_XML_File_Format|intermediate XML file]]. In a second step, the XML tree is converted into an ODF spreadsheet. Two kinds of conversions are available: In the &#039;&#039;detailed&#039;&#039; conversion, a set of sheets is created, there each sheet contains the data for a log file, a thread, a particular load save operation, or another sub tree of the log file. In the &#039;&#039;summary&#039;&#039; conversion, each sheet additionally contains column group where each group contains the data for load/save operation, ot another sub tree of the log file.<br /> <br /> === Command Line ===<br /> <br /> The RTL_LOGFILE analysis tool is invoked by one of these commands:<br /> <br /> java -jar rtllog2xml.jar -d &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;xml file&gt;<br /> java -jar rtllog2xml.jar [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -s [-t &lt;xpath&gt;] [-T &lt;xpath&gt;] -g &lt;xpath&gt; [-G &lt;xpath&gt;] [-i &lt;xpath&gt;] &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> java -jar rtllog2xml.jar -p &lt;profile&gt; &lt;rtl log file&gt; [&lt;rtl log file&gt; ...] &lt;ods file&gt;<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is not provided, the given RTL log files &#039;&#039;&lt;rtl log file&gt;&#039;&#039; are transformed into a spreadsheet document &#039;&#039;&lt;ods file&gt;&#039;&#039;. A sheet is created for each node in the intermediate XML file that is matched by the XPath expression specified with the option &#039;&#039;&#039;-t&#039;&#039;&#039;. A title for the spreadsheet can be specified by the option &#039;&#039;&#039;-T&#039;&#039;&#039;. The XPath expression specified by this option is evaluated with the nodes selected by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes, and the resulting string value is used as title.<br /> <br /> If &#039;&#039;&#039;-s&#039;&#039;&#039; is provided, the results on the sheet are grouped into columns. For each sub tree in the intermediate XML file, a set of columns is created that contains the entries for that group. The groups are selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes specified by &#039;&#039;&#039;-t&#039;&#039;&#039; as context nodes. The number of entries must be the same for each group. The same applies to their function names and messages. A title for each group can be specified by the &#039;&#039;&#039;-G&#039;&#039;&#039; option, which takes an XPath expression that is evaluated with the nodes selected by the &#039;&#039;&#039;-g&#039;&#039;&#039; option as context nodes.<br /> <br /> The &#039;&#039;&#039;-i&#039;&#039;&#039; option allows to specify an include filter. It takes a boolean XPath expression, which is evaluated for each descendant node of the nodes selected by the &#039;&#039;&#039;-t&#039;&#039;&#039; and &#039;&#039;&#039;-g&#039;&#039;&#039; options. Only nodes where the result of evaluating the expression is &#039;&#039;true&#039;&#039; are included.<br /> <br /> If &#039;&#039;&#039;-d&#039;&#039;&#039; is provided, the given RTL log files are transformed into an XML file only.<br /> <br /> If &#039;&#039;&#039;-p&#039;&#039;&#039; is specified a profile is selected. A profile is a set of XPath expressions for the above options.<br /> <br /> === Intermediate XML File Format===<br /> <br /> The intermediate XML File contains the following elements and attributes:<br /> <br /> ==== &lt;root&gt; ====<br /> <br /> &lt;tt&gt;&lt;root&gt;&lt;/tt&gt; is the root element. It has no attributes. The child elements are &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;file&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;comment&gt; ====<br /> <br /> The &lt;tt&gt;&lt;comment&gt;&lt;/tt&gt; element contains a comment. It is created for all lines in the RTL log file which do not start with a time stamp.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element contains the data for a single log file. One &lt;tt&gt;&lt;file&gt;&lt;/tt&gt; element is created for each file name that is passed as parameter to &#039;&#039;RTLLog2XML&#039;&#039;. The file name is included in the attribute &lt;tt&gt;name&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;file&gt; ====<br /> <br /> The &lt;tt&gt;&lt;thread&gt;&lt;/tt&gt; element contains the data for a single thread. The thread id is included in the attribute &lt;tt&gt;thread-id&lt;/tt&gt;. The child elements are &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; and &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt;.<br /> <br /> ==== &lt;block&gt; ====<br /> <br /> The &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;{&#039;&#039;&#039; or &#039;&#039;&#039;}&#039;&#039;&#039;. A single &lt;tt&gt;&lt;block&gt;&lt;/tt&gt; element is created for each matching pair of these lines. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;start-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;{&#039;&#039;&#039; line. The &lt;tt&gt;end-time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;}&#039;&#039;&#039; line. Both time stamps are specified as [http://www.w3.org/TR/xmlschema-2/#duration XSD durations].<br /> <br /> ==== &lt;stamp&gt; ====<br /> <br /> The &lt;tt&gt;&lt;stamp&gt;&lt;/tt&gt; element contains the data of RTL log file lines which have a type &#039;&#039;&#039;|&#039;&#039;&#039;. The &lt;tt&gt;function&lt;/tt&gt; attribute contains the function name, if present in the log file line. The &lt;tt&gt;owner&lt;/tt&gt; attribute contains the author, if present in the log file line. The &lt;tt&gt;component&lt;/tt&gt; attribute contains the component, if present in the log file line. The &lt;tt&gt;time&lt;/tt&gt; attribute contains the time stamp included in the &#039;&#039;&#039;|&#039;&#039;&#039; line as [http://www.w3.org/TR/xmlschema-2/#duration XSD duration].</div>

Mib