Report

org.eclipse.mat.api.report

0.7.0

Reports specify a number of queries which are executed in batch mode and are rendered into HTML files and zipped for easy distribution. Reports can be run from the command line by specifying the report id: MemoryAnalyzer.exe

<!ELEMENT extension (report)+>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT report EMPTY>

<!ATTLIST report

id          CDATA #REQUIRED

name        CDATA #REQUIRED

file        CDATA #REQUIRED

description CDATA #IMPLIED>


Following is an example of a report declaration:

   

<extension point=

"org.eclipse.mat.report.report"

>

<report id=

"suspects"

name=

"Leak Suspects"

description=

"includes leak suspects and a system overview"

file=

"META-INF/reports/suspects.xml"

/>

</extension>

Following is a sample report:

<section name=

"Leak Suspects"

>

<section name=

"System Overview"

>

<param key=

"html.separate_file"

value=

"true"

/>

<template>

org.eclipse.mat.api:overview

</template>

</section>

<query name=

"Leaks"

>

<command>

leakhunter

</command>

</query>

</section>

In short: sections contain other sections or queries. Queries specify the command to be run. Sections can contain a template element which specifies another report to be included here.

The Memory Analyzer supplies a number of reports itself. Check out the org.eclipse.mat.api plug-in.