Getting started with Agent Controller - OS/400

This guide contains the following information:

• Prerequisites
• Configuring and starting Agent Controller
• Server logging
• Invoking the Java Profiler
• Uninstalling Agent Controller

Prerequisites

• Install the TPTP 4.1.0 Runtime.
• Install the Java runtime (JRE) or Java development kit (JDK) 1.4
• Remove or uninstall all existing installations of Agent Controller.
• Agent Controller for OS/400-ISERIES requires the IBM XML Toolkit (5733-XT1) to be installed. Please contact your iSeries vendor for a copy of the IBM XML Toolkit. Alternatively, if you have a copy of the Enterprise edition of iSeries, you may already have a copy of the Toolkit on your CD of optional programs. For the latest information about iSeries related XML technologies, see the following Web site:  http://publib.boulder.ibm.com/iseries/v5r1/ic2924/index.htm?info/rzamj/rzamjtoolkit.htm.

Configuring and starting Agent Controller

<ifs restore directory> = The absolute directory path where the IFS portion of Agent Controller has been restored.

1. In the HYADESDC library, create an empty save file called HYADESDC.SAVF by typing: CRTSAVF HYADESDC/HYADESDC
   
2. Transfer the downloaded HYADESDC.SAVF to the iSeries library HYADESDC, overwriting the save file created above.
3. Restore the save file HYADESDC.SAVF located to the library HYADESDC, by typing:
   RSTOBJ OBJ(*ALL) SAVLIB(HYADESDC) DEV(*SAVF) SAVF(HYADESDC/HYADESDC)
   
4. Restore the save file HYADESIFS.SAVF in HYADESDC to the IFS directory /opt/hyadesdc. For example,
   RST DEV('/QSYS.LIB/HYADESDC.LIB/HYADESIFS.FILE') OBJ('/opt/hyadesdc/*')
   
5. Generate the configuration file that provides the rules for the applications that can be executed by the server.  This can be accomplished by running the <ifs restore directory>/bin/SetConfig.sh script. Run this script from a qshell (launched via STRQSH) in the <ifs restore directory>/bin directory. This step will require that a Java Virtual Machine (JVM) be present in the system's PATH. Follow the prompts and the output will be the <ifs restore directory>/config/serviceconfig.xml file.
   
6. Add the HYADESDC library to the library list entry by running: ADDLIBLE HYADESDC
   
7. Start the server by running: SBMJOB CMD(CALL RASERVER) JOBD(RASTART)
   
8. Stop the server by running: ENDJOB JOB(RASTART) OPTION(*IMMED)

If you want to make a change to the configuration file that was generated in step 7, the file can be manually edited using the rules outlined in the document Agent Controller configuration files. The server must be restarted to load changes.

Server Logging

Invoking the Java Profiler

The Java Profiler is a library that attaches to a JVM to capture and record the Java application's behavior. The output from the profiling agent is in the form of XML fragments.

Documentation on the composition of these XML fragments is located at: http://www.eclipse.org/tptp/platform/documents/resources/profilingspec/XML4Profiling.htm

Invocation of the Java Profiler from the Hyades Workbench

The Java Profiler can be launched from the Eclipse workbench. From the Profiling and Logging Perspective of Eclipse workbench you can launch applications using the Run > Profile menu or the toolbar button. Applications in the current Eclipse workbench's workspace or external Java applications located in the file system can be launched and profiled.

Invocation of the Java Profiler from the Command Line

Note: Step 5 in Configuring and starting Agent Controller is required for invoking the Java Profiler from the command line. Also, multithread capability must be enabled to profile a java application from the command line. Under QShell, the environment variable QIBM_MULTI_THREADED must be set to Y by the command: export QIBM_MULTI_THREADED=Y. The Java Profiler is invoked from a command line using the -Xrun JVM option as follows:

    -XrunpiAgent[:agent_parm[,agent_parm]*

• server=[standalone | enabled | controlled | applicationControlled]

  standalone

  The Java Profiler is manually attached to a JVM instance and generates a stand-alone trace to a specified file based on the options and filters given on the command line. When this option is selected, the Java Profiler produces the enclosing traceRoot element to form a complete and valid XML document.

  enabled

  The Java Profiler is loaded, allows the application to run normally, but produces no trace until a Eclipse workbench attaches to the agent to give it instructions. When this option is selected, the Java Profiler only produces XML fragments instead of a complete XML document.

  controlled

  The Java Profiler is loaded, and the application is blocked from running until a client gives it instructions to continue. When this option is selected, the Java Profiler only produces XML fragments instead of a complete XML document.

  applicationControlled

  Profiling operations are controlled by the TPTP "Profiler" java class. The pluginconfig.xml file must be modified to use this mode. The pluginconfig.xml is located in the following directory:

  <agent_controller_home>\plugins\org.eclipse.tptp.platform.collection.framework_4.0.0\config\pluginconfig.xml

  The following modification is required:

  <Agent client="DYNAMIC" configuration="default" dataChannelSize="64M" name="Java Profiling Agent" type="Profiler"/>

  should be modified to

  <Agent client="HEADLESS" configuration="default" dataChannelSize="64M" name="Java Profiling Agent" type="Profiler" logFile="C:\profile.trcxml"/>

  Note that the Agent client attribute has been changed to "HEADLESS" and that the "logFile" attribute has been added.
  The hcframe.jar file should also be included in the user's class path when profiling an application under this mode. For example:

   java -XrunpiAgent:server=applicationControlled -classpath "C:\AgentController\lib\hcframe.jar";. TestClass

• filters=filename
  NOTE: This parameter is only used when server=standalone is specified.
  Specifies the name of the file that contains the initial class filter definitions to be used during the trace. The default is filters.txt in the current directory. The format of the file is as follows:

          classpattern methodpattern mode , where:
  

  classpattern

  is a string with no embedded blanks. The string may contain a single "*" either at the beginning of the string or at the end of the string. The "*" will match zero or more characters, thus making the pattern a generic prefix or suffix pattern. A single "*" can also be specified to represent all strings.

  methodpattern

  is a string with no embedded blanks. The string may contain a single "*" either at the beginning of the string or at the end of the string. The "*" will match zero or more characters, thus making the pattern a generic prefix or suffix pattern. A single "*" can also be specified to represent all strings.

  mode

  is one of INCLUDE or EXCLUDE. Filter patterns are processed in the order that they are specified until the first pattern match succeeds. If the class name does not match any of the specified filter patterns, the default is to INCLUDE the class.

• file=filename
  NOTE: This parameter is only used when server=standalone is specified.
  Specifies the name of a file where the trace will be written. The default is trace.xml in the current directory.
• help
  Displays a list of available agent options to standard out.

Uninstalling Agent Controller

To uninstall the agent controller:

1. Stop the agent controller by running the following command:

   ENDJOB JOB(RASTART) OPTION(*IMMED)

2. Remove the Agent Controller library HYADESDC and its contents.
3. Remove the IFS directory /opt/hyadesdc (including all subdirectories and files) with the following command from a qshell:

   rm -r /opt/hyadesdc/*