Xense Profiler for DFC

Version 1.3

Xense Profiler for DFC is a powerful performance analysis tool that enables you to analyse Documentum 6 DFC (Documentum Foundation Class) trace files and locate performance data quickly. It is a java-based command line tool that accepts a DFC trace as input and outputs a summary report in HTML.

Xense Profiler for DFC supports the following functionality:

Accepts DFC trace files of any size
Reports created in HTML format
DFC Call summary report
Top 10 long-running DFC calls report
Top 10 long-running Queries report
Query Summary report
Top Queries and Query Summary contains the true duration of the query not just the duration of the intial execut statement (see Top Queries below)

Please read the Licensing information in the accompanying file Licensing.txt before installing and using this software.

Requirements and Installation

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. If you experience problems running Xense Profiler please let us know by mailing to profiler_support@xense.co.uk. Please provide details on the operating system, java version and the error messages being displayed.

To install:

Download the installation file to a directory on your machine
Unzip the contents to the directory
Open the file dfcprof.xml and copy your licence key into the tag <entry key="licenseKey">
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 [trace_file] [output_file]

[trace_file] is the DFC trace file to be analysed. [output_file] 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

On other systems Xense Profiler for DFC can be run from the command line using the following syntax:

java -jar DFCProf.jar [trace_file] [output_file]

[trace_file] is the DFC trace file to be analysed. [output_file] 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.

Show RPCs functionality

The report for Top 10 DFC Calls 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

There is no information shown in the reports
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)

Profiler exits with message "License Expired!"
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

Please let us know what you think of Xense Profiler for DFC and how it can be improved by mailing to profiler_development@xense.co.uk.