view vm-heap-analysis/distribution/plugin.xml @ 1014:89add75f3b71

Convert Heap command.properties to plugin.xml This commit moves the definitions for the heap-related commands to the heap plugin's plugin.xml file. I have also updated the list-heap-dumps usage string to reflect that hostId and vmId are optional arguments, and fixed a spacing issue in the description for the logLevel built-in argument. Reviewed-by: jerboaa Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-February/005933.html
author Elliott Baron <ebaron@redhat.com>
date Thu, 28 Feb 2013 12:17:32 -0500
parents 53ce942c35c1
children
line wrap: on
line source

<?xml version="1.0"?>
<!-- 

 Copyright 2012, 2013 Red Hat, Inc.

 This file is part of Thermostat.

 Thermostat is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published
 by the Free Software Foundation; either version 2, or (at your
 option) any later version.

 Thermostat is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with Thermostat; see the file COPYING.  If not see
 <http://www.gnu.org/licenses />.

 Linking this code with other modules is making a combined work
 based on this code.  Thus, the terms and conditions of the GNU
 General Public License cover the whole combination.

 As a special exception, the copyright holders of this code give
 you permission to link this code with independent modules to
 produce an executable, regardless of the license terms of these
 independent modules, and to copy and distribute the resulting
 executable under terms of your choice, provided that you also
 meet, for each linked independent module, the terms and conditions
 of the license of that module.  An independent module is a module
 which is not derived from or based on this code.  If you modify
 this code, you may extend this exception to your version of the
 library, but you are not obligated to do so.  If you do not wish
 to do so, delete this exception statement from your version.

-->
<plugin>
  <commands>
    <command type="extends">
      <name>gui</name>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-client-core-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-client-swing-${project.version}.jar</bundle>
      </bundles>
    </command>
    <command type="extends">
      <name>agent</name>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-agent-${project.version}.jar</bundle>
      </bundles>
    </command>
    <!-- Requires all storage entity classes to be loaded -->
    <command type="extends">
      <name>webservice</name>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
      </bundles>
    </command>
    <command type="provides">
      <name>dump-heap</name>
      <description>trigger a heap dump on the VM</description>
      <usage>dump-heap --hostId &lt;host&gt; --vmId &lt;vm&gt; [-d &lt;url&gt; [-u &lt;user&gt; -p &lt;password&gt;]] [-l &lt;level&gt;]</usage>
      <options>
        <option>
          <short>a</short>
          <long>hostId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the host to monitor</description>
        </option>
        <option>
          <short>v</short>
          <long>vmId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the VM to monitor</description>
        </option>
        <option common="true">
          <long>dbUrl</long>
        </option>
        <option common="true">
          <long>username</long>
        </option>
        <option common="true">
          <long>password</long>
        </option>
        <option common="true">
          <long>logLevel</long>
        </option>
      </options>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
      </bundles>
      <dependencies>
        <dependency>thermostat-common-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-core-${project.version}.jar</dependency>
        <dependency>thermostat-client-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-cli-${project.version}.jar</dependency>
        <dependency>thermostat-storage-mongodb-${project.version}.jar</dependency>
        <dependency>thermostat-web-common-${project.version}.jar</dependency>
        <dependency>thermostat-web-client-${project.version}.jar</dependency>
        <dependency>mongo.jar</dependency>
        <dependency>commons-beanutils.jar</dependency>
        <dependency>commons-codec.jar</dependency>
        <dependency>commons-collections.jar</dependency>
        <dependency>commons-logging.jar</dependency>
        <dependency>httpcomponents-core.jar</dependency>
        <dependency>httpcomponents-client.jar</dependency>
        <dependency>gson.jar</dependency>
        <dependency>netty.jar</dependency>
      </dependencies>
    </command>
    <command type="provides">
      <name>find-objects</name>
      <description>finds objects in a heapdump</description>
      <usage>find-objects [-d &lt;url&gt; [-u &lt;user&gt; -p &lt;password&gt;]] [-l &lt;level&gt;] --heapId &lt;id&gt; --limit &lt;limit&gt; &lt;pattern&gt;</usage>
      <options>
        <option>
          <short>h</short>
          <long>heapId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the heapdump to analyze</description>
        </option>
        <option>
          <short>L</short>
          <long>limit</long>
          <hasArg>true</hasArg>
          <required>false</required>
          <description>limit search to top N results, defaults to 10</description>
        </option>
        <option common="true">
          <long>dbUrl</long>
        </option>
        <option common="true">
          <long>username</long>
        </option>
        <option common="true">
          <long>password</long>
        </option>
        <option common="true">
          <long>logLevel</long>
        </option>
      </options>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
      </bundles>
      <dependencies>
        <dependency>thermostat-common-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-core-${project.version}.jar</dependency>
        <dependency>thermostat-client-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-cli-${project.version}.jar</dependency>
        <dependency>thermostat-storage-mongodb-${project.version}.jar</dependency>
        <dependency>thermostat-web-common-${project.version}.jar</dependency>
        <dependency>thermostat-web-client-${project.version}.jar</dependency>
        <dependency>mongo.jar</dependency>
        <dependency>commons-beanutils.jar</dependency>
        <dependency>commons-codec.jar</dependency>
        <dependency>commons-collections.jar</dependency>
        <dependency>commons-logging.jar</dependency>
        <dependency>httpcomponents-core.jar</dependency>
        <dependency>httpcomponents-client.jar</dependency>
        <dependency>gson.jar</dependency>
        <dependency>netty.jar</dependency>
      </dependencies>
    </command>
    <command type="provides">
      <name>find-root</name>
      <description>finds the shortest path from an object to a GC root</description>
      <usage>find-root --heapId &lt;heap&gt; --objectId &lt;object&gt; [-a] [-d &lt;url&gt; [-u &lt;user&gt; -p &lt;password&gt;]] [-l &lt;level&gt;]</usage>
      <options>
        <option>
          <short>h</short>
          <long>heapId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the heapdump to analyze</description>
        </option>
        <option>
          <short>o</short>
          <long>objectId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the object to query</description>
        </option>
        <option>
          <short>a</short>
          <long>all</long>
          <hasArg>false</hasArg>
          <required>false</required>
          <description>finds all paths to GC roots</description>
        </option>
        <option common="true">
          <long>dbUrl</long>
        </option>
        <option common="true">
          <long>username</long>
        </option>
        <option common="true">
          <long>password</long>
        </option>
        <option common="true">
          <long>logLevel</long>
        </option>
      </options>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
      </bundles>
      <dependencies>
        <dependency>thermostat-common-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-core-${project.version}.jar</dependency>
        <dependency>thermostat-client-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-cli-${project.version}.jar</dependency>
        <dependency>thermostat-storage-mongodb-${project.version}.jar</dependency>
        <dependency>thermostat-web-common-${project.version}.jar</dependency>
        <dependency>thermostat-web-client-${project.version}.jar</dependency>
        <dependency>mongo.jar</dependency>
        <dependency>commons-beanutils.jar</dependency>
        <dependency>commons-codec.jar</dependency>
        <dependency>commons-collections.jar</dependency>
        <dependency>commons-logging.jar</dependency>
        <dependency>httpcomponents-core.jar</dependency>
        <dependency>httpcomponents-client.jar</dependency>
        <dependency>gson.jar</dependency>
        <dependency>netty.jar</dependency>
      </dependencies>
    </command>
    <command type="provides">
      <name>list-heap-dumps</name>
      <description>list all heap dumps</description>
      <usage>list-heap-dumps [--hostId &lt;host&gt;] [--vmId &lt;vm&gt;] [-d &lt;url&gt; [-u &lt;user&gt; -p &lt;password&gt;]] [-l &lt;level&gt;]</usage>
      <options>
        <option>
          <short>a</short>
          <long>hostId</long>
          <hasArg>true</hasArg>
          <required>false</required>
          <description>the ID of the host to monitor</description>
        </option>
        <option>
          <short>v</short>
          <long>vmId</long>
          <hasArg>true</hasArg>
          <required>false</required>
          <description>the ID of the VM to monitor</description>
        </option>
        <option common="true">
          <long>dbUrl</long>
        </option>
        <option common="true">
          <long>username</long>
        </option>
        <option common="true">
          <long>password</long>
        </option>
        <option common="true">
          <long>logLevel</long>
        </option>
      </options>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
      </bundles>
      <dependencies>
        <dependency>thermostat-common-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-core-${project.version}.jar</dependency>
        <dependency>thermostat-client-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-cli-${project.version}.jar</dependency>
        <dependency>thermostat-storage-mongodb-${project.version}.jar</dependency>
        <dependency>thermostat-web-common-${project.version}.jar</dependency>
        <dependency>thermostat-web-client-${project.version}.jar</dependency>
        <dependency>mongo.jar</dependency>
        <dependency>commons-beanutils.jar</dependency>
        <dependency>commons-codec.jar</dependency>
        <dependency>commons-collections.jar</dependency>
        <dependency>commons-logging.jar</dependency>
        <dependency>httpcomponents-core.jar</dependency>
        <dependency>httpcomponents-client.jar</dependency>
        <dependency>gson.jar</dependency>
        <dependency>netty.jar</dependency>
      </dependencies>
    </command>
    <command type="provides">
      <name>object-info</name>
      <description>prints information about an object in a heap dump</description>
      <usage>object-info --heapId &lt;heap&gt; --objectId &lt;object&gt; [-d &lt;url&gt; [-u &lt;user&gt; -p &lt;password&gt;]] [-l &lt;level&gt;]</usage>
      <options>
        <option>
          <short>h</short>
          <long>heapId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the heapdump to analyze</description>
        </option>
        <option>
          <short>o</short>
          <long>objectId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the object to query</description>
        </option>
        <option common="true">
          <long>dbUrl</long>
        </option>
        <option common="true">
          <long>username</long>
        </option>
        <option common="true">
          <long>password</long>
        </option>
        <option common="true">
          <long>logLevel</long>
        </option>
      </options>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
      </bundles>
      <dependencies>
        <dependency>thermostat-common-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-core-${project.version}.jar</dependency>
        <dependency>thermostat-client-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-cli-${project.version}.jar</dependency>
        <dependency>thermostat-storage-mongodb-${project.version}.jar</dependency>
        <dependency>thermostat-web-common-${project.version}.jar</dependency>
        <dependency>thermostat-web-client-${project.version}.jar</dependency>
        <dependency>mongo.jar</dependency>
        <dependency>commons-beanutils.jar</dependency>
        <dependency>commons-codec.jar</dependency>
        <dependency>commons-collections.jar</dependency>
        <dependency>commons-logging.jar</dependency>
        <dependency>httpcomponents-core.jar</dependency>
        <dependency>httpcomponents-client.jar</dependency>
        <dependency>gson.jar</dependency>
        <dependency>netty.jar</dependency>
      </dependencies>
    </command>
    <command type="provides">
      <name>save-heap-dump-to-file</name>
      <description>saves a heap dump to a local file</description>
      <usage>save-heap-dump-to-file --heapId &lt;heap&gt; --file &lt;filename&gt; [-d &lt;url&gt; [-u &lt;user&gt; -p &lt;password&gt;]] [-l &lt;level&gt;]</usage>
      <options>
        <option>
          <short>h</short>
          <long>heapId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the heapdump to analyze</description>
        </option>
        <option>
          <short>f</short>
          <long>file</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the file name to save to</description>
        </option>
        <option common="true">
          <long>dbUrl</long>
        </option>
        <option common="true">
          <long>username</long>
        </option>
        <option common="true">
          <long>password</long>
        </option>
        <option common="true">
          <long>logLevel</long>
        </option>
      </options>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
      </bundles>
      <dependencies>
        <dependency>thermostat-common-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-core-${project.version}.jar</dependency>
        <dependency>thermostat-client-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-cli-${project.version}.jar</dependency>
        <dependency>thermostat-storage-mongodb-${project.version}.jar</dependency>
        <dependency>thermostat-web-common-${project.version}.jar</dependency>
        <dependency>thermostat-web-client-${project.version}.jar</dependency>
        <dependency>mongo.jar</dependency>
        <dependency>commons-beanutils.jar</dependency>
        <dependency>commons-codec.jar</dependency>
        <dependency>commons-collections.jar</dependency>
        <dependency>commons-logging.jar</dependency>
        <dependency>httpcomponents-core.jar</dependency>
        <dependency>httpcomponents-client.jar</dependency>
        <dependency>gson.jar</dependency>
        <dependency>netty.jar</dependency>
      </dependencies>
    </command>
    <command type="provides">
      <name>show-heap-histogram</name>
      <description>show the heap histogram</description>
      <usage>show-heap-histogram --heapId &lt;heap&gt; [-d &lt;url&gt; [-u &lt;user&gt; -p &lt;password&gt;]] [-l &lt;level&gt;]</usage>
      <options>
        <option>
          <short>h</short>
          <long>heapId</long>
          <hasArg>true</hasArg>
          <required>true</required>
          <description>the ID of the heapdump to analyze</description>
        </option>
        <option common="true">
          <long>dbUrl</long>
        </option>
        <option common="true">
          <long>username</long>
        </option>
        <option common="true">
          <long>password</long>
        </option>
        <option common="true">
          <long>logLevel</long>
        </option>
      </options>
      <bundles>
        <bundle>thermostat-vm-heap-analysis-common-${project.version}.jar</bundle>
        <bundle>thermostat-vm-heap-analysis-command-${project.version}.jar</bundle>
      </bundles>
      <dependencies>
        <dependency>thermostat-common-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-core-${project.version}.jar</dependency>
        <dependency>thermostat-client-command-${project.version}.jar</dependency>
        <dependency>thermostat-client-cli-${project.version}.jar</dependency>
        <dependency>thermostat-storage-mongodb-${project.version}.jar</dependency>
        <dependency>thermostat-web-common-${project.version}.jar</dependency>
        <dependency>thermostat-web-client-${project.version}.jar</dependency>
        <dependency>mongo.jar</dependency>
        <dependency>commons-beanutils.jar</dependency>
        <dependency>commons-codec.jar</dependency>
        <dependency>commons-collections.jar</dependency>
        <dependency>commons-logging.jar</dependency>
        <dependency>httpcomponents-core.jar</dependency>
        <dependency>httpcomponents-client.jar</dependency>
        <dependency>gson.jar</dependency>
        <dependency>netty.jar</dependency>
      </dependencies>
    </command>
  </commands>
</plugin>