Xense Profiler for DFC - v1.3 Beta ================================== 30 October 2008 What is Xense Profiler for DFC? ------------------------------- Xense Profiler for DFC is a performance profiling tool for analysing traces created by Documentum Foundation Classes (DFC) version 6 or higher. The Profiler analyses the DFC trace and produces a number of useful reports that allow you to quickly pinpoint the causes of your performance problems. Xense Profiler for DFC only works with traces created by DFC v6 and above. It will not work with traces created by DFC v5 and below. A separate application, Xense Profiler for DMCL can be used to analyse DMCL traces created by Documentum 5 applications. This beta is for evaluation purposes only - please read the accompanying license. Changes for v1.3 ---------------- - Top 10 DFC calls report now provides information on the number of RPCs issued for each call - Each call listed in Top 10 DFC calls report has a 'Show RPCs' action link that displays a list of the RPCs issued during the call and the duraction of each RPC - Fixed bug that sometimes resulted in the number of rows recorded against a query being 1 greater than actually occurred - Fixed cosmetic bug when displaying the text of a DQL call Changes for v1.2 ---------------- - Supports DFC 6.5 - Fixed a bug where DQL queries containing carriage returns are ignored - Improved formatting of numbers in the HTML reports Changes for v1.1 ---------------- - Xense Profiler will work correctly if RPC details are included in the trace (dfc.tracing.include_rpcs = true in the dfc.properties). Previously traces had to be generated with include_rpcs = false to give correct results. - On windows systems Xense Profiler for DFC can be invoked using the batch file dfcprof.bat giving a simpler invocation syntax on Windows systems (see 'Running Xense Profiler for DFC - Windows' below for deatils. Requirements ------------ Platform: Xense Profiler has been developed and tested against Windows and Red Hat Linux OS platforms however it should run on any system with a Sun Java Virtual Machine (JVM) version 5 or higher. Installation ------------ 1. Download the installation file to a directory on your machine 2. Unzip the contents to the directory 3. Open the file dfcprof.xml and copy your licence key into the tag 4. Save the changes to dfcprof.xml Running Xense Profiler for DFC - Windows ---------------------------------------- On Windows systems Xense Profiler for DFC can be run from the command line using the following syntax: dfcprof is the DFC trace file to be analysed. is the file name where HTML output is to be written. for example: dfcprof slow_login.log slow_login.htm Will analyse the DFC trace file slow_login.log and create HTML-based report slow_login.htm. The output can be viewed in any web browser. Running Xense Profiler for DFC - All other platforms ---------------------------------------------------- Xense Profiler for DFC can be run from the command line or shell using the following syntax: java -jar DFCProf.jar is the DFC trace file to be analysed. is the file name where HTML output is to be written. for example: java -jar DFCProf.jar slow_login.log slow_login.htm Will analyse the DFC trace file slow_login.log and create HTML-based report slow_login.htm. The output can be viewed in any web browser. nb. ensure you have set the JAVA_HOME environment variable to point to a supported version of java (JRE5 or higher). Show RPCs functionality ----------------------- The report for Top 10 DFC Calls not records the number of RPCs issued during the processing of the DFC call. If there are RPC calls issued for a call, the row in the report for that call will contain a link 'show RPCs'. When this link is clicked the Call Text field will expand to display further information on each RPC issued. The 'show RPCs' and 'hide RPCs' functionality requires that javascript be enabled in the browser. RPC information will only be available if the trace is generated with the dfc.tracing.include_rpcs property set to true in the dfc.properties file. Format of DFC trace files ------------------------- The range of tracing settings that can be used in the dfc.properties file has vastly increased in Documentum 6. This release of Xense Profiler for DFC requires that traces are generated using certain options, as follows: dfc.tracing.max_stack_depth=1 dfc.tracing.include_rpc_count=true dfc.tracing.include_rpcs=true dfc.tracing.mode=compact Troubleshooting --------------- Q. There is no information shown in the reports A. Check that you are using a version 6 (or higher) DFC trace. Check that the trace has been generated with the correct tracing parameters (see Format of DFC trace files above) Q. Profiler exits with message "License Expired!" A. Check that you have entered your license key correctly in the dfcprof.xml; there should be no leading or trailing spaces. If this doesn't fix the problem please contact the support team at dfcprof_beta@xense.co.uk. note. there is not charge for beta licenses. Bugs, Feature Requests and Comments ----------------------------------- Feedback on all aspects of the Xense Profiler for DFC beta can be sent to dfcprof_beta@xense.co.uk.