Beta 1.9 of the EM Management Plug-in Development Kit (EM PDK) lint and performance tools

1. Overview

2. Key Features

2.1. lint tool

2.2. performance tool

3. Install Instructions

4. Supported Platforms

5. Enhancements in this version

6. Know Issues

7. Examples

7.1. lint

7.2. perf

1. Overview

This beta version of the Enterprise Manager Management Plug-in Development Kit contains command line tools designed to aid in the development and testing of Management Plug-in's. It is assumed that the user is familiar with the Enterprise Manager Extensibility Guide found at the [Enterprise Manager Extensions Exchange] page on the [Oracle Technology Network]. Please post your comments, questions and ideas for enhancements to the extensibility forum.

2. Key Features

2.1. lint tool

Verify that a Management Plug-in (MP) has correct XML syntax in its metadata files, validate them against dtd files, and do some semantic checking to report possible problems.

2.2. performance tool

Collect metrics defined by the plug-in metadata and generate an HTML performance report. The performance report can be used to evaluate the performance impact the plug-in will have on the EM agent and repository when deployed into an Enterprise Manager Grid Control environment. This tool should be run several times for a given target type in a controlled environment, varying the load and/or configuration of the targets being monitored. When the tool is run, the agent will be temporarily disconnected from the OMS. Given this, the tool should not be run in production environments.

3. Install Instructions

• Download the kit (pdk_BETA_1.9.jar) to a system which has a 10.1.X or 10.2.X Agent installed.
• Extract the contents of the kit (e.g. "jar -xvf pdk_BETA_1.9.jar"). This will create a directory called "mptools".
• On Unix systems, make the files in the "mptools/bin" directory executable (e.g. "chmod +x mptools/bin/*").
• Ensure that the $ORACLE_HOME environment variable is set to a 10.1.X or 10.2.X Agent home.
• Issue the command "mptools/bin/mpcli -help" for the command usage and summary.

4. Supported Platforms

• Linux, Windows, and other Unix systems.

5. Enhancements in this version

• The PDK tools now run on Windows (tested on XP)
• Timeseries charts are shown in the performance report
• The performance report now correctly reports the number of warning and critical alerts per target instance metric
• The log output shows the location of the file PDK_Report_<timestamp>.jar which bundles together all report files and any data files saved by the new -save_metric_data option

6. Know Issues

• Generation of performance reports can take a long time depending on how much data is collected.

7. Examples

7.1. lint

stacb05> mpcli lint -target_type=oracle_aria -metadata=oracle_aria_ttd.xml -collection=oracle_aria_dc.xml
MPLINT PARSE ERROR: <xml_file=oracle_aria_ttd.xml>: <Line 1, Column 63>: XML-20137: (Error) Attribute 'BADTAG' used but not declared.
MPLINT PARSE ERROR: <xml_file=oracle_aria_ttd.xml>: <Line 65, Column 16>: XML-20148: (Error) Invalid element 'Proparty' in content of 'QueryDescriptor', expected elements '[Property]'.
MPLINT ERROR: <xml_file=oracle_aria_ttd.xml>: Computed columns can be specified only after other columns
MPLINT ERROR: <xml_file=oracle_aria_ttd.xml>: No container for TableDescriptor
MPLINT ERROR: <xml_file=oracle_aria_ttd.xml>: Invalid value for META_VER in TargetMetadata
MPLINT WARNING: <xml_file=oracle_aria_ttd.xml>: TargetMetadata META_VER for target type oracle_aria too long. Has been truncated.
MPLINT WARNING: <xml_file=oracle_aria_ttd.xml>: Label Employee Name xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx very long. Has been truncated.

7.2. perf

C:\Documents and Settings\cfowler\tst8\mptools\bin>mpcli perf -time=60

      Date: Fri Nov  3 10:38:04 2006
      Current directory: C:/Documents and Settings/cfowler/tst8/mptools/bin

      ====================================
      ===     Command: mpcli perf      ===
      ====================================

           Optional Argument   Value
           -----------------   -----
         # -agent_home         =
         # -config_file        =
         # -debug              =
         # -help               =
         # -hide_uncollected   =
         # -mp_deploy          =
           -out_dir            = C:\Documents and Settings\cfowler\tst8\mptools\bin\mp_stats_logs
         # -regexp_match       =
         # -save_metric_data   =
         # -separator          =
         # -subseparator       =
         # -targets            =
           -time               = 60
         # -xml_file           =

      Agent Home:      C:\OracleHomes\agent10g
      Agent State Dir: C:\OracleHomes\agent10g

      ==> If command interrupted, recover by: remove C:\OracleHomes\agent10g\sysman\emd\targets.xml.mp_stats_lock
      =========================
      === Doing agent setup ===
      =========================
      Stopping agent
      Clearing all target instances
      ==> If command interrupted, recover by: move C:\OracleHomes\agent10g\sysman\emd\targets.xml.mp_stats_save C:\Oracl
eHomes\agent10g\sysman\emd\targets.xml
      Adding target instances from file 'C:\OracleHomes\agent10g\sysman\emd\targets.xml'
      ---- these target instances now exist in targets.xml
           (C:\OracleHomes\agent10g\sysman\emd\targets.xml):
               cfowler-pc:host
               CSF9204E_cfowler-pc:oracle_database
               CSF9204_cfowler-pc:oracle_database
               CSFMAIN_cfowler-pc:oracle_database

      Disabling agent upload to OMS
      ==> If command interrupted, recover by: move C:\OracleHomes\agent10g\sysman\config\emd.properties.mp_stats_save C:
\OracleHomes\agent10g\sysman\config\emd.properties
      Starting agent

      ===========================================
      === Collecting metrics performance data ===
      ===========================================
      Start Time: Fri Nov  3 10:42:12 2006
      Agent will be polled for up to 60 minutes ...
      ---- agent will be polled for up to 50 more minutes
      ---- agent will be polled for up to 40 more minutes
      ---- agent will be polled for up to 29 more minutes
      ---- agent will be polled for up to 19 more minutes
      ---- agent will be polled for up to 9 more minutes
      Generating agent performance report
      Stopping agent
      Stop Time: Fri Nov  3 11:41:38 2006

      Gathering metric statistics for target type 'host'
      Gathering metric statistics for target type 'oracle_database'

      ======================================
      === Restoring original agent state ===
      ======================================
      Restoring all target instances to targets.xml
      Enabling agent upload to OMS
      Starting agent

      =========================================================================
      ==> MP Performance Report: C:\Documents and Settings\cfowler\tst8\mptools\bin\mp_stats_logs\mp_stats_2006_11_03_10
_38_05\BasicReport.htm

      ==> Run Log: C:\Documents and Settings\cfowler\tst8\mptools\bin\mp_stats_logs\mp_stats_2006_11_03_10_38_05\mp_stat
s.log

      ==> PDK Report Jar: C:\Documents and Settings\cfowler\tst8\mptools\bin\mp_stats_logs\mp_stats_2006_11_03_10_38_05 PDK_Report_2006_11_03_10_38_05.jar
      =========================================================================