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
The properties file contains:
n
The object's resource type name and the product portion of the name of the plug-in that manages it:
dumper.plugin
Specifies the product portion of the plug-in name. This is equivalent to setting the plug-in name
in the command line with -p.
dumper.type
Specifies the resource type name. This is equivalent to setting the resource type in the command
line with -t .
n
Resource configuration data that is required to use the metric, track, or control methods on an
resource. The sample JBoss properties file above supplies values for java.naming.provider.url,
program, and server.log_track.files.
Inherited Resource Properties
Some resource properties might be inherited from a parent resource.
For example, the properties file for a JBoss 4.2 Hibernate Session Factory service, shown below, includes all
of the properties discovered for its parent - a JBoss 4.2 server. The only service-level property in this file in
Application.
# same as '-p "jboss"'
dumper.plugin=jboss
# same as '-t "JBoss 4.2 Hibernate Session Factory"'
dumper.type=JBoss 4.2 Hibernate Session Factory
#192.168.0.12 JBoss 4.2 default hq Hibernate Session Factory
#Fri Jan 22 12:56:05 PST 2010
java.naming.provider.url=jnp://0.0.0.0:2099
program=/Applications/HQEE42GA/server-4.2.0-EE/hq-engine/bin/run.sh
application=hq
server.log_track.files=../../../logs/server.log
configSet=default
Properties for Controlling Agent Behavior and Plug-in Execution
You can use -DOption=Value to set any agent or system property.
This table lists some properties that are useful when you run a plug-in from the command line.
Property Description
log
Use this property to set the log level. log=debug.
output.dir
Use this property to override the default output directory default.
plugins.include
This agent property tells theEndpoint Operations Management agent to load a specific plug-in, and
only that agent before executing the method. Otherwise, when you run dcs-tools-pdk-shared-
VERSION.jar the Endpoint Operations Management agent loads all the plug-ins in the plug-in
directory.
plugins.exclude
This agent property gives the agent a list of plug-ins that must not be loaded before executing the
method. The Endpoint Operations Management agent loads all other plug-ins in the plug-in
directory.
exec.sleep
Use this system property to override its default value when you are testing a script plug-in. By
default, exec.sleep is 30 seconds. If your script might take longer than that to run, it is useful to
increase the value while you check the plug-in out.
Methods and Functions of the dcs-tools-pdk.jar File
You can use the methods and functions that are specified in the dcs-tools-pdk.jar file when you create
your plug-ins.
Chapter 1 Introduction to Plug-in Development
VMware, Inc. 29