6.1
Table Of Contents
- Endpoint Operations Management Agent Plug-in Development Kit
- Contents
- About the Endpoint Operations Management Agent Plug-in Development Kit
- Introduction to Plug-in Development
- The Role of the Server and Agent in Plug-ins
- Technical Overview
- Plug-in Implementations
- Using Support Classes to Simplify a Plug-in
- Writing Plug-ins
- JMX Plug-in
- Script Plug-ins
- SNMP Plug-in
- JMX-Based Management
- Auto-Discovery of JMX Resources
- Configuration Properties for JMX Monitoring
- Creating a Custom JMX Plug-in
- Defining Service Types to Provide Management via Custom MBeans
- Defining an ObjectName to Access Custom MBeans
- Defining Configuration Properties to Appear in the User Interface
- Defining and Gathering Metrics
- Specifying the Availability Metric for MBeans
- Implementing Control Actions
- Defining the Server Auto-Inventory Element
- Discovering Custom Properties
- Running and Testing Plug-ins from the Command Line
- Using Auto-Discovery Support Classes in Plug-ins
- Working with Plug-in Descriptors
- Plug-In Support Classes
- Index
Specifying Auto-Discovery Implementation for a Resource Type
You specify the class that performs auto-discovery for a resource type in a <plugin> element of type
autoinventory.
The following is an example of an auto-discovery Implementation for a resource type.
<server name="Java Server Name" version ="version #">
...
<plugin type="autoinventory" class="org.hyperic.hq.product.jmx.MxServerDetector"/>
...
</server>
Supplying Parameters for Auto-Discovery Implementation
All auto-discovery implementations discover server types by scanning the process table or Windows
registry for processes that match a Sigar process query.
You specify the process query in an option element named process.query (inside a <config> element) in the
<server> element for a server type. Data that you define in an option element appears as part of a resource,
and can be edited as required.
Data defined in a property element cannot be edited for a resource in the
VMware vRealize Operations Manager user interface. The parameters that are required to discover services
vary by plug-in implementation. Discovery of JMX services requires ObjectNames, discovery of SNMP
services requires an OID.
Measurement Plug-ins
A measurement plug-in is the part of a resource plug-in that implements metric collection. It can identify a
resource instance and collect metrics for it.
A custom plug-in that leverages the vRealize Operations Manager base measurement classes consists of only
the plug-in XML descriptor. For example, most custom JMX measurement plug-ins use the
vRealize Operations Manager JMX measurement classes. To write a custom JMX plug-in you typically just
define the resources and the required metrics in an XML file, which is the complete plug-in.
Writing the XML Descriptor
Each plug-in requires an XML descriptor that specifies the type of plug-in, the resources to look for and the
metrics to collect from them. The topic describes the major elements that you must include in that descriptor
file.
Measurement Support Classes
Here are the vRealize Operations Manager classes for metric collection.
org.hyperic.hq.product.
MeasurementPlugin
This is the vRealize Operations Manager base measurement class. The
getValue() method is called when a plug-in is asked for a metric value. This
class is extended by the following classes, each of which specifies a
getValue() method for a specific type of metric collection.
n
JMX
n
JDBC
Chapter 2 Using Auto-Discovery Support Classes in Plug-ins
VMware, Inc. 41