# Report

###### Identifier:

org.eclipse.mat.api.report

###### Since:

0.7.0

###### Description:

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 <heap dump> <report id>

###### Configuration Markup:

<!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

>

- id - The unique id of the report. Used when running the report from the command line or when including the report into another report via the template element.
- name - Display name to be displayed in menus.
- file - The XML file defining the report.
- description - Description to be displayed in the status line and/or welcome page.

###### Examples:

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.

###### API Information:

See report.xsd for an XML schema for the report definition.

###### Supplied Implementation:

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

Copyright (c) 2008,2010 SAP AG and IBM Corporation.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/