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
Argument Description
PluginName Identifies the plug-in to document.
If not specified, the action is applied to all plug-ins.
GenerateAction
Specifies a type of document to generate.
Available options are:
n
metrics-wiki Writes a Confluence Wiki-formatted summary of supported metrics to a file.
n
metrics-xml Outputs an XML-formatted summary of supported metrics for an object type to
stdout.
n
metrics-txt Outputs a text-formatted summary of supported metrics for an object type to
stdout.
n
help
Outputs the contents of the <help> element for each object type in the plug-in descriptors to
HTML files in the ./plugin-help directory.
TrackAction
Specifies whether to track log events or configuration events.
Use with the log or track options.
Example: Various Usage Options
In the following examples, only the method invocation and command options are shown. The java -jar
AgentHome/bundles/AgentBundle/pdk/lib/dcs-tools-pdk-VERSION.jar portion of the command is not
shown.
Command Purpose
-m generate -a metrics-wiki
To document metrics in Confluence Wiki format for all object types in all
plug-ins.
-m generate -a metrics-txt
To document metrics in text format for all object types in all plug-ins.
-m generate -a metrics-xml
To document metrics in XML format for all object types in all plug-ins.
-m generate -a help
To generate a help page for all object types in all plug-ins.
Append -p jboss to the command line.
To limit results to the object types managed by a single plug-in, in this
example, JBoss.
Running Protocol Checks from the Command Line
In addition to running a plug-in from the command line to test or document the plug-in, you can use the
command line option to quickly retrieve metrics on-demand.
For example, you can run the netservices plug-in from the command line to check the availability of a
variety of network service types.
To monitor an object of one of the types listed below on an on-going basis, you configure it as a platform
service object on the required platform. The Endpoint Operations Management agent performs remote
availability checks and metric collection.
To enable monitoring, you supply object configuration data, at a minimum, the hostname of the service
object.
To run the plug-in from the command line, you must supply the required configuration data on the
command line.
The netservices plug-in can monitor remote objects of the following types.
n
HTTP
n
POP3
n
IMAP
Endpoint Operations Management Agent Plug-in Development Kit
36 VMware, Inc.